Skip to content

docs: fix ordered list numbering in docs/FAQS.md - #10358

Closed
TINGyu123644 wants to merge 2 commits into
microsoft:mainfrom
TINGyu123644:fix/docs-faqs-numbering
Closed

TINGyu123644 wants to merge 2 commits into
microsoft:mainfrom
TINGyu123644:fix/docs-faqs-numbering

Conversation

@TINGyu123644

@TINGyu123644 TINGyu123644 commented Nov 14, 2026 •

Copy link
Copy Markdown

Summary

In docs/FAQS.md, the "How do I get access to nightly builds?" procedure used the marker 1. for every top-level step. Because Markdown renumbers a list by its starting integer, all seven steps rendered identically as 1., 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-list 1. (correct Markdown for a nested item) and is unchanged in content.

Scope: a 6-line modification inside docs/FAQS.md only. No code, no tests, no links altered. Diff is purely a documentation-correctness fix.

Type of change

  • Documentation fix (trivial per 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

  • Change is confined to docs/FAQS.md (a Markdown file); no build or test impact.
  • Rendered list now shows steps 1–7 in order.

Related Issue

None — trivial documentation correction, explained here per CONTRIBUTING.md.

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 to 1.–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

@TINGyu123644
TINGyu123644 deployed to github-app-auth November 16, 2026 04:37 — with GitHub Actions Active
@baywet

Copy link
Copy Markdown
Member

GitHub/markdown handles the numbering automatically when you keep 1. everywhere.

Closing this PR as it doesn't provide any additional value

@TINGyu123644

Copy link
Copy Markdown
Author

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.

This branch was successfully deployed

1 active deployment
github-app-auth — e9cbb207 Deployed Nov 16, 2026 by TINGyu123644 via add_label #27901
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants