Use-case guides, first four (phase 3) - #559
Draft
joshdrake wants to merge 6 commits into
Draft
Conversation
…ng, and skill Rewrites the Wi-Fi tutorial as use-cases/wifi.mdx with the fixed anchors, vendor tabs for access points, per-MDM delivery tabs, placeholder tokens, and REST and Terraform side by side. The access-point vendor reference moves to reference/access-points.mdx, the RADIUS authorization webhook specification to reference/radius-webhooks.mdx, and the Windows WLAN and LAN profile XML to reference/wlan-profile-xml.mdx. Ten troubleshooting entries under troubleshooting/wifi/ come from the current page and the agent troubleshooting page. skills/wifi/SKILL.md walks the guide's steps and says which an agent can do through the API. The guide no longer assumes Smallstep set up the backend (EFF-275): the dedicated RADIUS deployment is described as provisioned by Smallstep in one sentence, and every other object is created by the customer. Vale: API field names added to the vocabulary; Device.* metadata keys and placeholder tokens ignored; the two code blocks that carry "Device.Serial" are wrapped in Google.Spacing toggles because vale does not skip fenced code here. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
Rewrites the wired tutorial as use-cases/wired.mdx, reusing the Wi-Fi credential and RADIUS server and creating only the wired network. The switch step keeps the vendor-neutral shape from the source because no vendor-specific switch content exists yet (WEB-3570); per-vendor tabs are named as planned. Four troubleshooting entries under troubleshooting/wired/ come from the source page and the wired use-case notes (Wired AutoConfig, MAB, issuer hash). skills/wired/SKILL.md walks the guide's steps. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
… and skill Rewrites the browser certificate tutorial as use-cases/web-apps.mdx. The guide creates the credential and the web app resource with the API instead of assuming support set the team up, gives the verifier step one tab (your app or proxy) and says which verifiers are not documented yet, and turns the per-OS browser policy material into Agent, Jamf Pro, and Google Workspace delivery tabs. Four troubleshooting entries under troubleshooting/web-apps/ come from the source page and the agent troubleshooting page. skills/web-apps/SKILL.md walks the guide's steps. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
…ated Replaces the phase 1 stub with a full guide written from the 2025-01-01 API specification (/sso, /sso/clients), the Terraform provider, and the howto.smallstep.com Okta article. The Smallstep-side objects are created with the API rather than by Smallstep staff; the Okta tab carries the article's steps, the Entra ID tab carries only the redirect URI and the mechanism. The page says at the top that it has not been walked against the product and stays hidden from the sidebar. Four troubleshooting entries under troubleshooting/sso-device-factor/ and skills/sso-device-factor/SKILL.md. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
Use cases: Wi-Fi, Wired, and Web apps (mTLS) point at the new guides; the previous tutorial pages stay in the manifest hidden from the sidebar so their URLs work until the cutover; SSO device factor stays hidden. Reference gains the access point, RADIUS webhook, and Windows profile XML pages. Troubleshooting gains an index page and one entry per symptom, grouped by use case, beside the agent page. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL
|
|
The four guides carried `entitlement: pro`. The tier that includes each use case is open (melange decision 24); the working assumption in the design and the brief is Team, the tier that includes device management, so the frontmatter says `team` until pricing says otherwise. The key is not rendered yet. 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 3 of the docs redesign: the first four use-case guides on the nine-step skeleton, each with troubleshooting entries and a skill.
Pages
use-cases/wifi.mdxtutorials/protect-wireless-networks.mdx(guide part); melangeuse-cases/wifi.md,concepts/setup-playbook.md(vendor and MDM tab set);learn/radsec.mdx; the 2025-01-01 spec; Terraform provider 0.7.0 docsuse-cases/wired.mdxtutorials/protect-wired-networks.mdx; melangeuse-cases/wired.md(dot3svc, PKCS#11 caveat, vendor list)use-cases/web-apps.mdxtutorials/browser-certificate-setup-guide.mdx; melangeuse-cases/browser-mtls.md; the spec's/protect/browser; Terraformsmallstep_browseruse-cases/sso-device-factor.mdxuse-cases/idp-device-factor.md; Notion "Add Smallstep to Okta as an Identity Provider" (Smallstep How-To, 2026-05-12); Notion "Okta: Creating Device IDP Using Retool" (2026-08-18) and "Configure Entra ID MFA [internal]" (2026-03-25) for the redirect URIs and the trust-roots rule; the spec's/ssoand/sso/clients; Terraformsmallstep_identity_provider*; the Console's Protect › SSO copyreference/access-points.mdxreference/radius-webhooks.mdxreference/wlan-profile-xml.mdxtroubleshooting/README.mdxtroubleshooting/wifi/*(10)platform/troubleshooting-agent.mdx(SCEP failures, cannot access a resource, doctor)troubleshooting/wired/*(4)use-cases/wired.md(dot3svc)troubleshooting/web-apps/*(4)platform/troubleshooting-agent.mdx(PKCS#11, expired certificates)troubleshooting/sso-device-factor/*(4)lifecycleFailureURIskills/{wifi,wired,web-apps,sso-device-factor}/SKILL.mdOld pages stay in the manifest with
hideFromSidebar: trueand retitled "(previous guide)".Redirects (for the cutover table)
/docs/tutorials/protect-wireless-networks/docs/use-cases/wifi/docs/tutorials/protect-wireless-networks#access-point-configuration-reference/docs/reference/access-points/docs/tutorials/protect-wireless-networks#radius-authorization-webhooks/docs/reference/radius-webhooks/docs/tutorials/protect-wired-networks/docs/use-cases/wired/docs/tutorials/browser-certificate-setup-guide/docs/use-cases/web-appsPlaceholder tokens
From the catalogue:
<<team-slug>>,<<ssid>>,<<radius-secret>>,<<authority-id>>,<<acme-directory>>,<<radius-server-name>>(used forserverHostname).New, to add to the catalogue:
<<api-token>>,<<nas-ip>>,<<radius-server-ip>>,<<radius-server-port>>,<<radius-server-id>>,<<credential-id>>,<<wifi-id>>,<<ethernet-id>>,<<browser-id>>,<<app-url>>,<<okta-domain>>,<<idp-issuer>>,<<idp-client-id>>,<<idp-client-secret>>.<<radius-servers.us-east>>is not used: today's managed RADIUS returns oneserverIP; per-region servers are the dedicated deployment, which the guide describes as provisioned by Smallstep.Choices made
entitlement: proon all four guides. The brief saidentitlement: teamor the tier the melange use-case file names; Team was removed on 2026-09-13 and the use-case files name no tier, so the paid self-serve tier is used. Change in one place per page if the entitlement fragment decides otherwise.awesomeWififlag and the customer-visible form is the older one. The Console is named as the place where every object appears.accept.txt;Device.*keys and<<tokens>>added toTokenIgnores; two code blocks per network guide are wrapped in{/* vale Google.Spacing = NO */}toggles because vale flagsDevice.Serialinside fenced code. The toggles render to nothing (checked).Checks
vale --no-wrap --glob='!step-cli/reference/**'on all 31 new pages: 0 errors (withmdx2vastinstalled per CONTRIBUTING).markdown-link-check -q -c .github/mdl.config.jsonper new page: 0 dead links. One false positive removed: the checker cannot resolve{#id}explicit anchors within a page, so the Wi-Fi verify step names step 8 in prose instead of linking#troubleshoot.what-you-get,before-you-start,create,configure-external,deliver,verify,operate,troubleshoot,automate)..mdxoutside.claude/,step-cli/reference/,skills/, and the two known exceptions.next dev -p 5052,content/docssymlinked to this branch): every new page returns 200 with no runtime error; the four guides render two tab lists each (steps 4 and 5); placeholder chips render in prose and in fenced code;#what-you-getand#automateids are present;/docs/use-cases/wifi.mdreturns the Markdown with tokens intact.Left out
🤖 Generated with Claude Code
https://claude.ai/code/session_01NZTV2L582SYSGwfbEQyrQL