Skip to content
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.

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

docs(rust): update cli documentation for the status and reset commands #8707

Merged
merged 2 commits into from
Jan 6, 2025

Conversation

adrianbenavides
Copy link
Member

@adrianbenavides adrianbenavides commented Dec 17, 2024

Cherry picks #8070 and #8646 and fixes merge conflicts with develop.

Kudos to @Wryhder !

@Wryhder
Copy link
Contributor

Wryhder commented Dec 21, 2024

@adrianbenavides I noticed the improvements you made to my commit from the closed PR (#8646). Thank you!

I was wondering if it's okay to combine the functions for enriching the preview and unsafe tags, since they're so similar. Could you take a look? Here are my changes: https://github.com/Wryhder/ockam/tree/cli-docs-(new-pr). (I'm not sure how to link my branch to this PR without creating another PR.)

Also, after making CLI docs-related changes, how do I preview the docs locally to verify everything looks as it should? I can see the tags on the command line if I do this, but I was wondering how to check the tooltip in the browser:

cargo build

target/debug/ockam --help

@adrianbenavides
Copy link
Member Author

hey @Wryhder ! Yeah, that's a good idea if it's not too much work.

You can generate the docs with the ockam markdown command. That will create a folder ockam_markdown_pages with all the md files that you can check. Checking the styling is a bit more involved, as it requires setting up the repo that serves the docs, but that's not necessary for this PR.

If you want, you can create a new PR and point it to this one, so I can merge your commit into it.

@adrianbenavides adrianbenavides added this pull request to the merge queue Jan 6, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 6, 2025
@adrianbenavides adrianbenavides added this pull request to the merge queue Jan 6, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 6, 2025
@adrianbenavides adrianbenavides added this pull request to the merge queue Jan 6, 2025
Merged via the queue into develop with commit 3bc66da Jan 6, 2025
44 checks passed
@adrianbenavides adrianbenavides deleted the adrian/wryhder-cil-changes branch January 6, 2025 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants