docs: fix markdown-structure warnings in guide docs#176
Merged
ootakazuhiko merged 2 commits intoFeb 12, 2026
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to eliminate check-markdown-structure warnings in documentation by adding explicit code-fence languages and normalizing headings to avoid multiple H1s.
Changes:
- Add
textlanguage identifiers to previously-untyped fenced code blocks across multiple docs. - Normalize
project-management/structure-review-round1.mdto a single H1 by demoting subsequent H1s to H2. - (Intended) update diagram docs to satisfy markdown-structure lint rules.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| tech-book-writing-6phases.md | Adds text to fenced blocks used for non-code examples. |
| src/chapter-introduction/index.md | Adds text to the directory-tree example fence. |
| docs/chapters/chapter-introduction/index.md | Mirrors the same text fence update as src/. |
| project-management/structure-review-round1.md | Demotes extra H1 headings to H2 to ensure only one H1. |
| docs/diagram/svg_style_guide.md | Attempts to add text to untyped fences, but currently breaks multiple code-fence closings. |
| docs/diagram/ai_diagram_guidelines.md | Adds text to many fenced blocks containing prompt templates and checklists. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
レビュー本文およびインライン7件(suggestion含む)を全件確認しました。
各インラインコメントには返信済みで、スレッドは解決済みです。 |
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.
Pull Request
目的
変更内容(概要)
docs/diagram/ai_diagram_guidelines.mdの言語未指定コードフェンスにtextを付与docs/diagram/svg_style_guide.mdの言語未指定コードフェンスにtextを付与docs/diagram/svg_style_guide.mdの closing fence 誤り(text になっていた箇所)を `` に修正tech-book-writing-6phases.mdの言語未指定コードフェンスにtextを付与src/chapter-introduction/index.md/docs/chapters/chapter-introduction/index.mdの言語未指定コードフェンスにtextを付与project-management/structure-review-round1.mdの H1 を1つに統一(残りを H2 へ変更)影響範囲
QA(必須)
Pages確認(原則必須)
検証
node ../book-formatter/scripts/check-markdown-structure.js . --fail-on warn(issues 0)ロールバック
関連Issue
AI支援の開示(任意)