Repository navigation
docs: fix ordered list numbering in docs/FAQS.md - #10358
TINGyu123644 wants to merge 2 commits into
Conversation
All top-level steps were numbered '1.', so they rendered identically. Renumber them sequentially 1-7. No nested sub-item changed. AI-assisted (spelling/formatting only); trivial doc correction per CONTRIBUTING.md.
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the documentation-only step-numbering change.
No open issues 🎉
What changed in this PR
This documentation-only change makes the nightly-build instructions’ step sequence explicit in the Markdown source.
Changes:
- Renumbers the seven top-level steps from repeated
1.markers to1.–7.. - Leaves the nested sub-step, commands, links, and instructional content unchanged.
| File | Description |
|---|---|
docs/FAQS.md |
Uses sequential source numbering for the nightly-build procedure. |
Review effort: Balanced
|
GitHub/markdown handles the numbering automatically when you keep 1. everywhere. Closing this PR as it doesn't provide any additional value |
|
Thanks for the clarification, Vincent Biret (@baywet) - you're right that GitHub Flavored Markdown auto-numbers ordered lists, so keeping 1. on every step still renders as a proper 1-7 sequence. My PR's premise about the rendered output was incorrect, and there's no additional value here, so I won't reopen it. Appreciate the quick and clear review. |
Summary
In
docs/FAQS.md, the "How do I get access to nightly builds?" procedure used the marker1.for every top-level step. Because Markdown renumbers a list by its starting integer, all seven steps rendered identically as1., making the sequence unreadable.This change renumbers the seven top-level steps sequentially
1.–7.. The single nested sub-step (1. Click the "Configure SSO" ...) is intentionally left as a sub-list1.(correct Markdown for a nested item) and is unchanged in content.Scope: a 6-line modification inside
docs/FAQS.mdonly. No code, no tests, no links altered. Diff is purely a documentation-correctness fix.Type of change
CONTRIBUTING.md— "an obvious correction whose desired result is not reasonably in dispute, such as fixing a typo or broken documentation link")AI Assistance
This contribution is materially AI-assisted (the contributor used a generative AI tool to draft the edited lines and this description). It is a trivial documentation correction; no issue was opened per the project's trivial-change guidance. The human contributor reviewed the change and owns the submission.
Verification
docs/FAQS.md(a Markdown file); no build or test impact.Related Issue
None — trivial documentation correction, explained here per
CONTRIBUTING.md.