Skip to content

docs: add missing guides to CLI guides landing#2747

Open
mvanhorn wants to merge 1 commit intoRedocly:mainfrom
mvanhorn:osc/1519-cli-guides-landing
Open

docs: add missing guides to CLI guides landing#2747
mvanhorn wants to merge 1 commit intoRedocly:mainfrom
mvanhorn:osc/1519-cli-guides-landing

Conversation

@mvanhorn
Copy link
Copy Markdown
Contributor

@mvanhorn mvanhorn commented Apr 17, 2026

What/Why/How?

Closes #1519. The CLI guides landing pages (docs/@v2/guides/index.md and docs/@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:

  • Configure API linting rules
  • Set up tab completion
  • Update Redocly CLI
  • Migrate to Redocly CLI v2
  • Migrate from openapi-cli
  • Migrate from redoc-cli
  • Migrate from Spectral
  • Migrate from swagger-cli

v1 landing gains 7 cards (same list minus the v2 migration card, which doesn't apply to v1 docs).

Reference

  • Issue: Update the CLI Guides landing page #1519 ("CLI docs have a landing page with guides on, but it's missing some of the migration guides and probably some other items. Update the page to include all guides and a little preview of what they are.")
  • Files touched: docs/@v1/guides/index.md, docs/@v2/guides/index.md

Testing

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

  • This PR follows the contributing guide
  • All new/updated code is covered by tests (docs-only; N/A)
  • Core code changed? - N/A (docs only)
  • New package installed? - N/A
  • Documentation update has been considered (this IS a documentation update)

Security

  • The security impact of the change has been considered (docs-only addition of existing internal links; no security surface)
  • Code follows company security practices and guidelines

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.

@mvanhorn mvanhorn requested a review from a team as a code owner April 17, 2026 05:16
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 17, 2026

⚠️ No Changeset found

Latest commit: 1aa6847

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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.

Update the CLI Guides landing page

1 participant