Skip to content

docs: restructure README (EN/JA) for readability - #9

Merged
reoring merged 1 commit into
mainfrom
docs/restructure-readme
Feb 20, 2026
Merged

reoring merged 1 commit into
mainfrom
docs/restructure-readme

Conversation

@reoring

@reoring reoring commented Feb 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add concise Features at a Glance / 特徴 section near the top so readers can quickly grasp what Roboppi does
  • Move the detailed capabilities list into a Reference section at the end (no content deleted)
  • Reorder sections for natural reading flow: intro → features → install → quickstart → architecture → reference details
  • Demote Workflow YAML, Agent Catalogs, Branch Safety, IPC Transport sections as subsections under Reference
  • Add hero image to Japanese README for consistency with English version

Before / After structure

Before After
Intro Intro (condensed to one paragraph)
What Roboppi Can Do (massive list) Features at a Glance (8 one-liners)
Architecture Install
Install Quickstart
Quickstart Architecture
Workflow YAML ---
Agent Catalogs Reference (Capabilities in Detail, Workflow YAML, Agent Catalogs, Branch Safety, IPC)
Branch Safety Documentation
Supervised IPC Development
Documentation Status
Development
Status

Test plan

  • Verify all original content is preserved (no technical information removed)
  • Check that internal links and doc references still work
  • Review both EN and JA versions render correctly on GitHub

🤖 Generated with Claude Code

Reorganize both READMEs so readers can quickly grasp what Roboppi is
and how to use it, while preserving all technical detail in a Reference
section at the end.

- Add concise "Features at a Glance" / "特徴" highlights near the top
- Move detailed capabilities list to "Reference > Capabilities in Detail"
- Reorder sections: intro → features → install → quickstart → architecture → reference
- Demote Workflow YAML, Agent Catalogs, Branch Safety, IPC sections under Reference
- Add hero image to Japanese README for consistency

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@reoring
reoring merged commit d65c7ad into main Feb 20, 2026
2 checks passed
@reoring
reoring deleted the docs/restructure-readme branch March 1, 2026 02:15
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