[docs] docs: tighten markdown reference guidance#47170
Merged
Merged
Conversation
pelikhan
approved these changes
Jul 22, 2026
pelikhan
marked this pull request as ready for review
July 22, 2026 05:49
Contributor
Author
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped. |
Contributor
There was a problem hiding this comment.
Pull request overview
Condenses markdown workflow guidance while preserving examples, security guidance, and core instructions.
Changes:
- Tightens introductory and writing guidance.
- Simplifies organization, failure-handling, and pitfalls prose.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/reference/markdown.md |
Clarifies and shortens markdown authoring guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Medium
Contributor
Author
|
🎉 This pull request is included in a new release. Release: |
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
Editorial pass over
docs/src/content/docs/reference/markdown.mdto tighten prose and improve clarity throughout the markdown reference guide.Changes
docs/src/content/docs/reference/markdown.mdDetails
docs/src/content/docs/reference/markdown.md
Impact
References: §29894884130