Land the redesigned docs tree (phase 1) - #557
Merged
Merged
Conversation
The sidebar now describes one platform organized by the reader's question: Start here, Learn, Use cases, Platform (Concepts, Inventory, Trust, Credentials, Verifiers, Audit), Automate, Reference, Troubleshooting, and Open source. Every existing page is slotted into the new tree unchanged, including the two pages that had no manifest entry (the VPN client guide, now under VPN) and the generated step CLI reference, carried verbatim. The Practical Zero Trust index and the retired ACME page leave the manifest; their redirects land with the site cutover. Five pages the tree needs but that are not yet written exist as short hidden stubs (Quickstart, For coding agents, How Smallstep hosts step-ca, SSO device factor, MCP servers) so the manifest resolves in full. The Certificate Manager, Smallstep SSH, and Registration Authorities introductions open with a note saying where their content now lives; the pages and their URLs stay. The docs index offers three doors (evaluating, building, operating), the use cases, and the open-source section instead of product cards. Every manifest path resolves to a file and no hand-written page is orphaned; the link check passes on every changed page. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
|
|
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
2 participants
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
Phase 1 of the docs redesign, on the
nextcontent branch (notmain): the new sidebar tree with every existing page slotted in unchanged, five hidden stubs for pages the tree needs but that are not yet written, landing notes on the three retired product introductions, and a rewritten index page.Nothing here reaches production.
nextis rendered by the staging deployment withDOCS_REF=next(smallstep/smallstep.com#1219); production keeps readingmainuntil the cutover in the migration plan.The tree
Start here 路 Learn 路 Use cases 路 Platform (Concepts, Inventory, Trust, Credentials, Verifiers, Audit) 路 Automate 路 Reference 路 Troubleshooting 路 Open source. Product sections (Platform, Smallstep SSH, Certificate Manager, Registration Authorities) are gone as top-level items; their pages live under the surface or use case they belong to, at the same URLs.
Checks
markdown-link-checkpasses on every changed page.valewas not available in my environment; please run it in CI.Where this comes from
Plan and page map:
melange/projects/docs-redesign/{README,page-map,migration}.md.馃 Generated with Claude Code
https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL