Skip to content

docs: use cargo-rdme to generate README.md - #44

Merged
hyperfinitism merged 3 commits into
mainfrom
chore/revise-doc
Sep 13, 2026
Merged

hyperfinitism merged 3 commits into
mainfrom
chore/revise-doc

Conversation

@hyperfinitism

Copy link
Copy Markdown
Owner

This pull request makes changes so that README.md is automatically generated from the doc comments in main.rs using cargo-rdme. This enables Rustdoc and README to be edited in sync.

Furthermore, the docs.yml workflow is added to inspect the documentation. This performs the following checks:

  1. cargo xtask manpages
  2. cargo doc --no-deps
  3. cargo rdme --check

@hyperfinitism hyperfinitism self-assigned this Sep 13, 2026
@hyperfinitism hyperfinitism added documentation Improvements or additions to documentation ci/cd CI/CD related items labels Sep 13, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 13, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-13T00:38:28.463810Z 1a619ab PR opened
🔒 Security Review Completed 2026-09-13T00:37:57.920761Z 1a619ab PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread .github/workflows/docs.yml
Comment thread src/main.rs
Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
@hyperfinitism
hyperfinitism merged commit 32a7d81 into main Sep 13, 2026
29 checks passed
@hyperfinitism
hyperfinitism deleted the chore/revise-doc branch September 13, 2026 00:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/cd CI/CD related items documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant