Consolidate install instructions into smallstep-agent page (EFF-313)#515
Merged
Conversation
The MDX renderer auto-slugs each `# heading` to the same kebab-case id already targeted by inbound links. The explicit `<a id="..."></a>` tags were producing a parallel id with a trailing dash (e.g. `id="system-requirements-"`) and visible whitespace in the rendered heading text. Removing them yields a single clean `id="system-requirements"` on the heading itself, and inbound links from troubleshooting-agent.mdx continue to resolve. EFF-313
The conditional phrasing was left over from when this page only covered manual install. Now the page is the canonical install guide regardless of distribution method; the MDM Alert that follows already handles the "but I'm on an MDM" case. EFF-313
…ection These stable, unversioned URLs were on the old smallstep-app page and got dropped in the initial consolidation. The releases.smallstep.com SPA only shows versioned artifacts, so the _latest aliases aren't surfaced anywhere else and are useful for embedding in scripts and docs. EFF-313
… over - Add a 'Running into trouble?' pointer to the troubleshooting guide just below the MDM callout in the Introduction. - Move the PKCS#11 troubleshooting subsection (logs + `pkcs11-tool` slot enumeration + p11-kit reference) from the install page into the existing 'PKCS#11 not working' section of troubleshooting-agent.mdx, where the rest of the PKCS#11 diagnostics already live. Replace the install-page subsection with a one-line link. EFF-313
J-Hunter-Hawke
approved these changes
May 21, 2026
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.
Summary
Consolidates the two overlapping agent-install docs pages into a single canonical install entry point at
/docs/platform/smallstep-agent/.smallstep-app.mdxcontent intosmallstep-agent.mdx. The new page covers macOS, Windows, and Linux end-to-end: unified System / Runtime / Connectivity requirements above the per-OS install sections, plus a Downloads section with both unversioned_latestURLs and a pointer toreleases.smallstep.comfor versioned artifacts with SHA-256 + signature verification.smallstep-app.mdx.enrollment-guide.mdxandtroubleshooting-agent.mdx. Collapses an accidental sed-induced duplicate link in enrollment-guide. Fixes pre-existing macOS Uninstall list step numbering (was 1, 3, 4).manifest.jsonnav: drops the "Install the Smallstep App" entry, renames "Deploy the Agent" → "Install the Smallstep Agent".Paired with a redirect in smallstep/smallstep.com#TBD — that PR must merge alongside this one or
/docs/platform/smallstep-app/will 404.Linear: EFF-313
Test plan
/docs/platform/smallstep-agent/with section order Introduction → System requirements → Runtime requirements → Connectivity requirements → Downloads → Linux / macOS / Windows installation.#system-requirements,#runtime-requirements,#connectivity-requirementsscroll to the right section (used bytroubleshooting-agent.mdx).troubleshooting-agent.mdx's "PKCS#11 not working" section renders with the moved-in Diagnose block + p11-kit doc link.🤖 Generated with Claude Code