docs: use cargo-rdme to generate README.md - #44
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
Code Review
This pull request integrates cargo-rdme to synchronize the project's README.md with the crate's root documentation in src/main.rs. It also updates and expands the documentation with new examples, including credential activation, NV extend indices, and NV counter indices, while correcting several CLI command arguments in existing examples. No review comments were provided, so there is no additional feedback.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1a619ab0a0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
1a619ab to
938cdf2
Compare
Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
938cdf2 to
018e8c5
Compare
This pull request makes changes so that
README.mdis automatically generated from the doc comments inmain.rsusingcargo-rdme. This enables Rustdoc and README to be edited in sync.Furthermore, the
docs.ymlworkflow is added to inspect the documentation. This performs the following checks:cargo xtask manpagescargo doc --no-depscargo rdme --check