Repository navigation
Conversation
Add the Smallstep.OrderedListNumbering rule. The rule finds numbered list items that skip or repeat a number. Each indentation level is a separate list. A list can continue after a code block. A new list can start at 1 after a heading or after other text. Correct the 33 list items in 8 pages that the rule found. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add the Smallstep.StepHeadingNumbering rule. The rule finds "Step N" headings that skip or repeat a number at the same heading level. A higher-level heading starts the count again. The first step can be 0 or 1. Add the Smallstep.NestedListIndent rule. The rule finds a nested list item that is not indented to the text column of its parent item. Markdown does not nest such an item. Correct the problems that the rules found: - In the Fleet guide, change the macOS steps 6 to 9 to steps 5 to 8, and refer to Step 4 for the configuration profile download. - In the Fleet guide, indent the three query detail lists below their parent step. - In the Okta sync guide, indent the App Catalog list below its parent step. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
tashian
enabled auto-merge
October 20, 2026 22:33
andysmallstep
approved these changes
Oct 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
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
This PR adds three Vale script rules to the
Smallstepstyle. It also corrects the problems that the rules found in the docs.New rules
All three rules use
extends: scriptwithscope: raw. Regex rules cannot do these checks, because Vale converts Markdown to HTML before it applies them. The rules ignore lines in fenced code blocks. Each rule has theerrorlevel.Smallstep.OrderedListNumberingfinds numbered list items that skip or repeat a number, for example1, 2, 4or1. 1. 1.. Each indentation level is a separate list. A list can continue after a code block. A new list can start at 1 after a heading or after other text.Smallstep.StepHeadingNumberingfinds "Step N" headings that skip or repeat a number at the same heading level. A higher-level heading starts the count again. The first step can be 0 or 1. Bold headings such as### **Step 1. ...**are also checked.Smallstep.NestedListIndentfinds a nested list item that is not indented to the text column of its parent item. For example, a sub-list below6.must have an indent of 3 spaces. Markdown does not nest an item with less indent.Markdown uses only the number of the first item in a list. Thus, most numbering errors in the source do not show on the site. The
OrderedListNumberingrule keeps the source correct for writers and reviewers. Heading numbers and nesting errors show on the site.Corrections
step-ca/provisioners.mdxshowed incorrectly on the site, because it started at 0.Test plan
vale --glob='!step-cli/reference/**' .shows no errors from theSmallsteprules.smallstep.comdev server. The Fleet macOS steps are 1 to 8, the GitOps text refers to Step 4, the three query detail lists and the App Catalog list are nested, and the YubiKey list starts at 1.馃 Generated with Claude Code