[codex] Normalize documentation book term spacing#31
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Normalizes Japanese/ASCII spacing around documentation-operation terms across the book content and examples, and updates the Node/npm dependency constraints to keep QA and audits reproducible.
Changes:
- Normalize spacing around separators (e.g.,
README / 手順書 / Runbook) across docs, book metadata, and MiniShop examples. - Add
engines.node >=20.18.1and pin transitive dependency versions viaoverridesto address current audit advisories. - Regenerate
package-lock.jsonto reflect the new engine constraint and overridden package versions.
Reviewed changes
Copilot reviewed 1 out of 33 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Aligns overview text spacing for README/Runbook/ADR term list and “公開 URL” wording. |
| package.json | Adds Node engine constraint and npm overrides; normalizes description spacing. |
| package-lock.json | Updates lockfile to reflect engine constraint and overridden transitive versions. |
| examples/minishop/runbook.md | Normalizes term spacing in MiniShop runbook example. |
| examples/minishop/README.md | Normalizes spacing for URL/Issue/PR and EC/API key wording. |
| examples/minishop/procedure-deploy.md | Normalizes spacing in deploy procedure example (DB/参照など). |
| examples/minishop/postmortem-2026-02-15.md | Normalizes spacing around “Runbook” term. |
| examples/minishop/incident-report-2026-02-15.md | Normalizes spacing around request-id. |
| examples/minishop/architecture.md | Normalizes spacing in Mermaid diagram labels and annotations. |
| examples/minishop/adr-0001-validation.md | Normalizes spacing around UX and flag OFF wording. |
| docs/index.md | Normalizes spacing in front-matter and chapter list labels. |
| docs/chapters/chapter-11/index.md | Normalizes spacing in chapter title and checklist items. |
| docs/chapters/chapter-10/index.md | Normalizes spacing in Docs-as-Code chapter text and headings. |
| docs/chapters/chapter-09/index.md | Normalizes spacing in postmortem chapter title and bullets. |
| docs/chapters/chapter-08/index.md | Normalizes spacing around ADR template link and example text. |
| docs/chapters/chapter-07/index.md | Normalizes spacing around Runbook template link and title. |
| docs/chapters/chapter-06/index.md | Normalizes spacing in “悪い例” snippet text. |
| docs/chapters/chapter-05/index.md | Normalizes spacing in diagram guidance and Mermaid labels. |
| docs/chapters/chapter-01/index.md | Normalizes spacing around document-type term lists. |
| docs/appendices/templates/runbook/index.md | Normalizes spacing in Runbook template example sections. |
| docs/appendices/templates/readme/index.md | Normalizes spacing in README template example sections. |
| docs/appendices/templates/postmortem/index.md | Normalizes spacing around Runbook/手順書 references. |
| docs/appendices/templates/index.md | Normalizes spacing in template index entry label. |
| docs/appendices/templates/incident-report/index.md | Normalizes spacing around RFC3339 and 5xx/timeout wording. |
| docs/appendices/templates/ci-minimum/index.md | Normalizes spacing in CI template title and explanatory text. |
| docs/appendices/templates/audit-memo/index.md | Normalizes spacing in “公開 URL” field label. |
| docs/appendices/templates/architecture-diagram/index.md | Normalizes spacing in Mermaid comment guidance text. |
| docs/appendices/templates/adr/index.md | Normalizes spacing around “社内 Wiki” and “SLI 再設計” wording. |
| docs/_data/navigation.yml | Normalizes spacing in navigation titles for chapters 7/9/10/11. |
| docs/_config.yml | Normalizes site description spacing. |
| BOOK-PROPOSAL.md | Normalizes spacing in proposal text and chapter list entries. |
| book-config.json | Normalizes spacing in book metadata (description, audience, chapter titles). |
| _config.yml | Normalizes root site description spacing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
js-yaml,markdown-it,linkify-it,undici) and declarenode >=20.18.1so local QA remains reproducible on the current Node 20 baseline.Verification
npm cinpm testnpm audit --omit=optionalnpm run buildgit diff --checkRefs: itdojp/it-engineer-knowledge-architecture#170