Skip to content

[codex] add documentation book usage guidance#24

Closed
ootakazuhiko wants to merge 1 commit into
mainfrom
codex/add-usage-guidance
Closed

[codex] add documentation book usage guidance#24
ootakazuhiko wants to merge 1 commit into
mainfrom
codex/add-usage-guidance

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

What changed

  • added usage, license, and update guidance to the top page
  • normalized Issue / PR wording in the prerequisites section

Why

  • the reader-facing top page still lacked direct guidance for reuse, update tracking, and license handling

Validation

  • git diff --check
  • bundle exec jekyll build --source docs --destination _site
  • node ../book-formatter/scripts/check-links.js docs
  • node ../book-formatter/scripts/check-markdown-structure.js docs --fail-on error

Copy link
Copy Markdown
Collaborator Author

当初の docs/index.md 差分は、現時点では main に対して tree を変えない no-op 状態です。重複レビューを避けるため、この draft PR は close します。

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.

1 participant