Skip to content

[codex] Normalize documentation book term spacing#31

Merged
ootakazuhiko merged 2 commits into
mainfrom
qs170/notation-20260627
Jun 27, 2026
Merged

[codex] Normalize documentation book term spacing#31
ootakazuhiko merged 2 commits into
mainfrom
qs170/notation-20260627

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

Summary

  • Normalize Japanese/ASCII spacing for documentation-operation terms across the published docs, README/book metadata, and the Minishop examples.
  • Add exact npm overrides for the current transitive audit advisories (js-yaml, markdown-it, linkify-it, undici) and declare node >=20.18.1 so local QA remains reproducible on the current Node 20 baseline.
  • Keep the change scoped to the #170 notation-quality sprint; no functional content or workflow behavior is changed.

Verification

  • npm ci
  • npm test
  • npm audit --omit=optional
  • npm run build
  • git diff --check

Refs: itdojp/it-engineer-knowledge-architecture#170

Copilot AI review requested due to automatic review settings June 27, 2026 02:36

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.1 and pin transitive dependency versions via overrides to address current audit advisories.
  • Regenerate package-lock.json to 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.

Comment thread docs/appendices/templates/runbook/index.md Outdated
Comment thread docs/appendices/templates/readme/index.md Outdated
Comment thread docs/chapters/chapter-11/index.md Outdated
Comment thread docs/chapters/chapter-01/index.md Outdated
Comment thread docs/appendices/templates/readme/index.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 33 changed files in this pull request and generated 4 comments.

Comment thread docs/chapters/chapter-01/index.md Outdated
Comment thread docs/appendices/templates/runbook/index.md Outdated
Comment thread docs/appendices/templates/readme/index.md Outdated
Comment thread docs/appendices/templates/readme/index.md Outdated
@ootakazuhiko ootakazuhiko merged commit 37f50f6 into main Jun 27, 2026
1 check passed
@ootakazuhiko ootakazuhiko deleted the qs170/notation-20260627 branch June 27, 2026 02:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants