Add linter for how-to guide steps with no commands - #637
Draft
ptgott wants to merge 1 commit into
Draft
Conversation
|
Amplify deployment status
|
ptgott
marked this pull request as ready for review
May 1, 2026 15:05
ptgott
marked this pull request as draft
May 1, 2026 15:06
ptgott
force-pushed
the
paul.gottschling/2026-04-29-followability
branch
from
June 18, 2026 14:30
ec7635e to
a2d402a
Compare
ptgott
force-pushed
the
paul.gottschling/2026-04-29-followability
branch
from
June 18, 2026 17:15
a2d402a to
be19961
Compare
ptgott
force-pushed
the
paul.gottschling/2026-04-29-followability
branch
from
June 26, 2026 13:50
be19961 to
67b9ec3
Compare
Per the linter, every H2 in the docs that begins "## Step [0-9]+" must include at least one code fence with the `code` label, indicating an example command that a CLI user or AI agent can follow. The aim of this linter is to make it easier for CLI users and AI agents to follow docs guides. To instruct the linter to ignore guides that genuinely require manual interaction, a docs author can add a `lint disable` comment for the whole page or a `lint ignore` comment for a particular guide. The linter checks specifically for commands, rather than commands or configuration snippets. This is because an agent can't necessarily glean from a configuration snippet how to apply it, e.g., by restarting Teleport or running `tctl apply`. While guides that pass the linter are not guaranteed to be followable by AI agents, passing the linter does remove a blocker for agents, and also helps ensures that human users who prefer the keyboard have an option available to them.
ptgott
force-pushed
the
paul.gottschling/2026-04-29-followability
branch
from
June 30, 2026 19:38
67b9ec3 to
c5101a8
Compare
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
1 participant
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.
Per the linter, every H2 in the docs that begins "## Step [0-9]+" must include at least one code fence with the
codelabel, indicating an example command that a CLI user or AI agent can follow. The aim of this linter is to make it easier for CLI users and AI agents to follow docs guides.To instruct the linter to ignore guides that genuinely require manual interaction, a docs author can add a
lint disablecomment for the whole page or alint ignorecomment for a particular guide.The linter checks specifically for commands, rather than commands or configuration snippets. This is because an agent can't necessarily glean from a configuration snippet how to apply it, e.g., by restarting Teleport or running
tctl apply.While guides that pass the linter are not guaranteed to be followable by AI agents, passing the linter does remove a blocker for agents, and also helps ensures that human users who prefer the keyboard have an option available to them.