Skip to content

Docs: Restructure README and split guides into docs/en + docs/ja#1132

Closed
ryz310 wants to merge 3 commits intomasterfrom
update-readme
Closed

Docs: Restructure README and split guides into docs/en + docs/ja#1132
ryz310 wants to merge 3 commits intomasterfrom
update-readme

Conversation

@ryz310
Copy link
Owner

@ryz310 ryz310 commented Feb 10, 2026

What

  • top-level README.md and README.jp.md were shortened into quick-start hub pages
  • detailed documentation was split into chapter files under docs/en and docs/ja
  • EN/JA docs were aligned to the same chapter structure

Why

  • the previous README files were too long to scan quickly
  • moving details into chapter files improves discoverability and maintenance
  • mirrored EN/JA structure makes updates easier and reduces drift

Included Changes

  • rewrote README.md to: overview, install, quick start, doc links
  • rewrote README.jp.md to the same concise structure
  • added docs/en/01-06 chapters:
    • getting started
    • usage and pagination
    • error handling
    • retry / timeout / logger
    • RSpec helpers
    • development and release
  • added matching docs/ja/01-06 chapters
  • fixed README typos and example inconsistencies found during the split

Scope

  • docs only
  • no runtime behavior changes

Verification

  • manual link/path check for all docs listed from README files
  • no tests run (documentation-only change)

@ryz310 ryz310 self-assigned this Feb 10, 2026
@ryz310 ryz310 changed the title Refactor README structure and split docs by chapter Docs: Restructure README and split guides into docs/en + docs/ja Feb 10, 2026
@ryz310
Copy link
Owner Author

ryz310 commented Mar 1, 2026

Recreate on #1180

@ryz310 ryz310 closed this Mar 1, 2026
@ryz310 ryz310 deleted the update-readme branch March 1, 2026 08:56
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