Skip to content

docs: Reorganise HIL documentation#15107

Merged
voisey merged 1 commit intomagma:masterfrom
voisey:reorganise-hil-docs
Mar 1, 2023
Merged

docs: Reorganise HIL documentation#15107
voisey merged 1 commit intomagma:masterfrom
voisey:reorganise-hil-docs

Conversation

@voisey
Copy link
Copy Markdown
Contributor

@voisey voisey commented Mar 1, 2023

Summary

Related to #14958

There is a "Hardware In Loop Testing" page in the docusaurus which is not linked in the sidebar, contains several links that can't be accessed, and contains some information that is duplicated in hil_testing/README.md. Given this and the fact that HIL testing is unmaintained, I suggest moving the information from the docusaurus to the readme, which I have done in this PR.

Test Plan

  • Successfully ran cd $MAGMA_ROOT/docs && make dev locally

@voisey voisey requested a review from a team as a code owner March 1, 2023 10:54
@voisey voisey requested a review from crasu March 1, 2023 10:54
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines. label Mar 1, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 1, 2023

Thanks for opening a PR! 💯

A couple initial guidelines

Howto

  • Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
  • Checks. All required CI checks must pass before merge.
  • Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

If this is your first Magma PR, also consider reading

@github-actions github-actions bot added the component: docs Documentation-related issue label Mar 1, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 1, 2023

DP Lint & Test

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0

Results for commit 5b89bf1.

@voisey voisey self-assigned this Mar 1, 2023
@voisey voisey merged commit 398652d into magma:master Mar 1, 2023
lucasgonze pushed a commit to lucasgonze/magma that referenced this pull request Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: docs Documentation-related issue size/M Denotes a PR that changes 30-99 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants