Docs redesign phase 2: Start here, Learn, Concepts, and the step-ca boundary page - #558
Merged
Conversation
Adds the "How Smallstep works" page (the enrollment-to-verification loop and the five surfaces, with one diagram), replaces the Quickstart stub with the condensed Wi-Fi golden path built from the Wi-Fi guide, and replaces the "For coding agents" stub with what exists today (Markdown source on GitHub, smallstep.com/llms.txt, the API spec) and a clearly labelled Planned section. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
…page Why device identity, Attestation explained, SCEP versus attestation, PKI in one page, Trust roots and chains, RadSec, Certificates for people, devices, and workloads, and the boundary page "How Smallstep hosts step-ca" (five fixed anchors; every step-ca mechanism is one sentence and a link). No steps; each ends with where it shows up in Smallstep. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
Adds platform/concepts/ with an IndexCard index and six concept pages (Inventory, Trust, Credentials, Verifiers, Policy, Audit). Each says what the object is, how it relates (one mermaid diagram), where it appears in the Console and API today, and which guides use it. Planned surfaces (the Trust tab with zones, a Policy tab with modes, a Sessions view, the MCP gateway) are named in one sentence each and marked as not available. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
Start here lists How Smallstep works (new path), Quickstart, and For coding agents; Learn lists the eight articles in order; Concepts gains the index and six pages. platform/README.mdx and platform/core-concepts.mdx stay in the manifest with hideFromSidebar so their URLs keep working until the cutover redirects. Every manifest path exists and every page outside step-cli/reference is in the manifest except acme-old and practical-zero-trust, as before. Adds four API field names and one word to the Smallstep vale vocabulary, quotes frontmatter descriptions that contain colons, and reorders mermaid node lines so vale's repetition check stays clean. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
|
|
…ust exists Their content fed the new Trust concept page; the pages and their URLs stay until the cutover redirects them, hidden from the sidebar so the Concepts group lists one Trust. 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
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.
Phase 2 of the docs redesign on the
nextcontent branch: the Start here pages, the Learn pillar, the Concepts pages, and the open-source boundary page. Every page carrieskind:in its frontmatter, uses the glossary vocabulary (the Console label in parentheses once where it differs), and describes only what is shipped; planned items are named in one sentence each and marked as not available.Pages
Start here
start-here/how-smallstep-works.mdx(new)platform/README.mdx("How can you use Smallstep?"),platform/core-concepts.mdx(the enrollment sequence), melangeconcepts/object-model.mdandconcepts/platform-unification.md; Console tab names from the web repo's top navigation onorigin/master(Home, Devices, Users, Audit, Protect, Certificate Manager ▾ with Authorities/Endpoints/Certificates)start-here/quickstart.mdx(replaces stub)tutorials/protect-wireless-networks.mdx(credential, Managed RADIUS, Wi-Fi resource, agent-managed clients, verify),platform/enrollment-guide.mdx,platform/smallstep-agent.mdx, melangeuse-cases/wifi.mdstart-here/for-coding-agents.mdx(replaces stub)platform/smallstep-api.mdx, the Terraform registry, melangeplg/agent-readable-onboarding.mdandprojects/docs-redesign/README.md("The agent contract") for the Planned sectionLearn
learn/why-device-identity.mdxplatform/README.mdx("Why cryptographic attested device identity?"), smallstep.com/llms.txt (ACME DA co-developed with Google)learn/attestation-explained.mdxplatform/core-concepts.mdx(assurance levels, secure elements, the four proofs, key protection levels, the Apple MDA note, the fallback note, the BYO note); the API'sHARDWARE_ATTESTED/HARDWARE_WITH_FALLBACKvalues from the Wi-Fi guidelearn/scep-versus-attestation.mdxplatform/README.mdx(the SCEP critique, static vs dynamic SCEP, the ADCS note),platform/core-concepts.mdx(provisional identity), melangeplatform/scep-as-credential.md(only for what SCEP is still for; the recipe it proposes is not described)learn/pki-in-one-page.mdxstep-ca/certificate-authority-core-concepts.mdx(linked, not copied),certificate-manager/how-it-works.mdx(passive vs active revocation), blog "Everything PKI" (linked)learn/trust-roots-and-chains.mdxconcepts/trust.md,architecture/trust-surface.md(theroots.pemURL, the four-places problem); the Wi-Fi, wired, relay, browser, and SSH host pages for where roots go today;certificate-manager/byo-root.mdxlearn/radsec.mdxuse-cases/wifi.md;tutorials/protect-wireless-networks.mdx(Managed RADIUS over UDP withnasIPs; Enterprise RADIUS with RadSec and a dedicated hostname, provisioned by Smallstep);tutorials/protect-wired-networks.mdx; RFC 6614 for the protocollearn/certificates-for-people-devices-and-workloads.mdxcertificate-manager/oidc.mdx(concept part),ssh/how-it-works.mdx(16 h default, principals, GitHub username), melangeconcepts/inventory.md(workloads),platform/core-concepts.mdx(the delegated pattern),tutorials/cloud-vm-certificate.mdxlearn/how-smallstep-hosts-step-ca.mdx(replaces stub)projects/docs-redesign/boundary.md(the five-anchor outline, followed exactly:#what-is-shared,#what-the-platform-adds,#what-is-different,#which-page,#running-your-own),step-ca/policies.mdx(policy scope),certificate-manager/how-it-works.mdx(Advanced authority options),certificate-manager/oidc.mdx(step ca provisioneragainst a hosted authority),tutorials/kubernetes-acme-ca.mdxandtutorials/acme-protocol-acme-clients.mdx(linked authorities exist), melangeconcepts/trust.mdConcepts
platform/concepts/README.mdxplatform/concepts/inventory.mdxglossary.md,concepts/inventory.md;platform/enrollment-guide.mdx; the 2025-01-01 API (/devices,/platforms,/device-enrollment-policy)platform/concepts/trust.mdxconcepts/trust.md,architecture/trust-surface.md;certificate-manager/core-concepts.mdxandhow-it-works.mdx;ssh/how-it-works.mdx(Cloud KMS); the API (/authorities,/certificates)platform/concepts/credentials.mdxglossary.md,concepts/object-model.md; the Wi-Fi guide's credential step; the 2025-01-01 API (/credentials,endpointManagementMode:agent,mdm,other; the deprecation note for/endpoint-configurationsand/accounts)platform/concepts/verifiers.mdxglossary.md,concepts/object-model.md; the Wi-Fi guide's three RADIUS options;tutorials/configure-enterprise-relay.mdx; the API (/managed-radius,/sso)platform/concepts/policy.mdxconcepts/policy.md(the four kinds and the "Today" column only);step-ca/policies.mdx;ssh/acls.mdx; the Wi-Fi guide (reply attributes);platform/enrollment-guide.mdxplatform/concepts/audit.mdxconcepts/audit.md(theshippedrows only);certificate-manager/webhook-events.mdx;ssh/how-it-works.mdx; the web repo's top navigation onorigin/master(the Audit tab is role-gated, not flag-gated)Manifest
Start here lists How Smallstep works (new path), Quickstart, and For coding agents, all visible. Learn lists the eight articles in the order above. Concepts gains the index with the six pages as children.
platform/README.mdxandplatform/core-concepts.mdxstay in the manifest withhideFromSidebar: trueso their URLs keep working until the cutover redirects. Every other entry is unchanged, including the two Certificate Manager pages still listed under the Concepts heading.Choices made
concepts/audit.mdmarks the Audit tabinternal(flagaudit) as of 2026-09-12, but the web repository's top navigation onorigin/mastergates it by role (owner, admin, device admin), with no feature flag. The page follows the code. If the tab is still flagged in production, change one sentence onplatform/concepts/audit.mdxandstart-here/how-smallstep-works.mdx.origin/master; the concept page uses the glossary word Trust for the surface, names the Console label (Authorities and Certificates under Certificate Manager) once, and says the Trust tab is planned in one sentence.#which-pagecomes from the heading "Which page?" (the renderer slugifies headings; explicit ids are a phase 3 item).nasIPs,autojoin,serverHostname(API field names that appear in code blocks) andaffordancesto.vale/styles/config/vocabularies/Smallstep/accept.txtso the new pages lint with zero errors.attestation-explained(about 1,000 words including its table) andhow-smallstep-works(about 940) run slightly over the brief's ranges; the rest are within range.Checks
vale --no-wrap --glob='!step-cli/reference/**'on all 18 changed pages: 0 errors, 82 warnings (allGoogle.Colonson frontmatter,Google.Headingson acronyms, and Oxford-comma suggestions on appositives; the same classes as thenextbaseline).markdown-link-check -q -c .github/mdl.config.jsonon all 18 pages: 0 dead links (217 links checked).certificate-manager/acme-old.mdxandpractical-zero-trust/README.mdx.Facts I could not source and left out
concepts/trust.md); the boundary page says only that.kind:frontmatter field (the brief says it is ignored today).🤖 Generated with Claude Code
https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL