Regenerate tcld command reference docs#4778
Open
lennessyy wants to merge 5 commits into
Open
Conversation
Regenerate all tcld reference docs using a new gen-docs tool that walks the urfave/cli command tree in the tcld repo. Adds missing pages for connectivity-rule, migration, and service-account commands. Updates all existing pages to reflect the current tcld command definitions.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links |
Handle commands with empty Usage fields in gen-docs by providing a fallback description string.
Angle brackets in flag usage text (e.g. <namespace>=<permission>) are parsed as JSX tags by MDX, causing build failures. Escape them as HTML entities.
MDX parses angle brackets as JSX tags and curly braces as expressions. Escape both in flag usage text to prevent build failures.
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
connectivity-rule,migration,service-account.The gen-docs tool lives in the tcld repo at
cmd/gen-docs/(PR to follow).Test plan
tcld --helpoutput┆Attachments: EDU-6604 Regenerate tcld command reference docs