docs: add missing guides to CLI guides landing#2747
Open
mvanhorn wants to merge 1 commit intoRedocly:mainfrom
Open
docs: add missing guides to CLI guides landing#2747mvanhorn wants to merge 1 commit intoRedocly:mainfrom
mvanhorn wants to merge 1 commit intoRedocly:mainfrom
Conversation
|
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
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.
What/Why/How?
Closes #1519. The CLI guides landing pages (
docs/@v2/guides/index.mdanddocs/@v1/guides/index.md) were missing cards for several guides that exist in the directory. This PR adds cards for them using the existing{% card %}pattern, with one-line previews sourced from the first paragraph of each guide.v2 landing gains 8 cards:
v1 landing gains 7 cards (same list minus the v2 migration card, which doesn't apply to v1 docs).
Reference
docs/@v1/guides/index.md,docs/@v2/guides/index.mdTesting
This is a docs-only change. No code paths, build scripts, or rules files were modified. The cards use the same
{% card title=... to="./..." %}...{% /card %}syntax as the existing cards on the same pages, so the docs renderer handles them the same way.Preview rendering is not locally previewable per the issue note ("this can't be previewed locally, but open a draft pull request to see the preview") — this PR is suitable for inspecting the rendered preview via your docs build.
Screenshots (optional)
N/A — docs content only.
Check yourself
Security
Closes #1519
This contribution was developed with AI assistance (Codex).
Note
Low Risk
Low risk docs-only change that adds internal links on the guides index pages; main risk is broken/incorrect relative paths or titles.
Overview
Updates the CLI guides landing pages (
docs/@v1/guides/index.md,docs/@v2/guides/index.md) to include additional guide cards that were previously missing.The new cards link to existing guides for lint rule configuration, shell completion, CLI updates, and multiple migration guides (plus a dedicated v1→v2 migration card on the v2 landing page), each with a short one-line description.
Reviewed by Cursor Bugbot for commit 1aa6847. Bugbot is set up for automated code reviews on this repo. Configure here.