Skip to content

nvx-rs: keep the README's module table to one short line per module #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pedro Henrique Penna (ppenna) merged 3 commits into from
Oct 28, 2026
Merged

nvx-rs: keep the README's module table to one short line per module #968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffc49bf
nvx-rs: describe each module of the README in a section of its own
ppenna Oct 28, 2026
833f321
doc: say where a module's details go in the nvx-rs README
ppenna Oct 28, 2026
8312f25
scripts: check that the nvx-rs README keeps each module's row short
ppenna Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@
nested repository. Do not claim unavailable hardware or cross-platform gates
passed; report the missing prerequisite and rely on CI when appropriate.

## Documentation

- In [`nvx-rs/README.md`](../nvx-rs/README.md#layout), each row of the module
table says in one line, of at most 200 characters, what a module is for, and
links to the module's section after the table, which holds the module's
details. Put a module's details in its section, wrapped like the rest of the
README, and change its row only when the module's purpose changes.

## Platforms And Hosts

- Linux supports `kvm` or `mshv`; Windows supports only `whp`. Select one backend
Expand Down
Loading
Loading