docs(readme): persona-first restructure of the README top (#156) - #171
Merged
Conversation
takashikasuya
force-pushed
the
claude/readme-persona-restructure
branch
from
July 15, 2026 13:03
c7d6a61 to
a1c9d86
Compare
…156) Reworks the first screenful of the 690-line README so a first-time reader immediately sees what it is, what it looks like, and the first command — instead of hitting Breaking-change / Azure-compat / IaC detail up front. New top section (after the intro): - screenshot/GIF placeholder (HTML comment + text pointer to the 3 core screens; actual captures need a live UI, so they are left for a maintainer) - 5-minute quickstart (2 commands + login) - ✨ 主要機能 (feature bullets) - 🧭 目的別の入口 — persona table A–F (demo / MQTT / gateway dev / twin / prod / API) linking straight to the relevant doc Demoted migration/compat detail from the architecture header to concise one-line pointers (Timescale→Parquet breaking change → oss-warm-parquet-lake.md / oss-tier-architecture.md; Azure IoT Hub bridge → system-architecture.md, which already documents it). Removed the duplicated legacy host-run steps (§5/§6/§7, which repeated §4) and folded the one unique detail (WithLocalAuth) into a pointer to getting-started.md. Retitled the detailed quickstart to 「起動手順(詳細)」. Mirrored the persona table + screenshot note in the English summary. Note: builds on the concepts.md added in #160 (PR #170) — merge that first so the docs/concepts.md links resolve. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Claude <noreply@anthropic.com>
takashikasuya
force-pushed
the
claude/readme-persona-restructure
branch
from
July 15, 2026 13:05
a1c9d86 to
ef754be
Compare
6 tasks
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.
Addresses #156.
Summary
Reworks the first screenful of the 690-line README so a first-time reader immediately sees
what it is → what it looks like → the first command → where to go for their goal, instead of
hitting Breaking-change / Azure-compat / IaC detail up front (the #156 acceptance criterion:
"README冒頭スクロール1画面以内に「何か・見た目・最初の1コマンド」が収まる").
New top section (right after the intro):
(
/resourcestree →/points/{id}chart → control dialog). Actual captures need a live UI, whichthis automated environment can't run, so they're explicitly left for a maintainer (marked in-file).
D twin / E prod / F API), each linking straight to the relevant doc.
Moved "migration / compat / IaC" detail out of the top (the other acceptance criterion):
header are collapsed to one-line pointers. Their full content already lives in the linked docs
(
oss-warm-parquet-lake.md/oss-tier-architecture.md;system-architecture.mdalready documentsthe Kandt/IoT Hub bridge), so nothing is lost.
detail (
WithLocalAuth) into a pointer togetting-started.md. Retitled the detailed quickstart to「起動手順(詳細)」.
Test plan
docs/links in the README verified to resolve (the only "missing" hit is the example pathinside the screenshot HTML comment — inert, not rendered).
concise pointer.
Checklist
Out of scope (possible follow-ups): real screenshots/GIF capture; relocating the lower-half env-var /
ports / deploy reference tables into dedicated docs (they already carry doc pointers and sit below the
fold).
🤖 Generated with Claude Code
Generated by Claude Code