Skip to content

docs(readme): restructure + prose pass for public-repo readability - #14

Merged
anggorodewanto merged 3 commits into
AccelByte:mainfrom
wahyuwidharto:docs/readme-restructure
Jul 15, 2026
Merged

anggorodewanto merged 3 commits into
AccelByte:mainfrom
wahyuwidharto:docs/readme-restructure

Conversation

@wahyuwidharto

Copy link
Copy Markdown
Contributor

Supersedes #13 (closed; could not be reopened after a history rewrite on the branch).

Summary

Three commits preparing the README for the repo going public. No behavior, code, or doc-of-record content is touched.

1. Restructure (content-preserving)

  • Table of contents after the intro.
  • Milestone paragraphs (M4 / M5.A / M5.B / M5.C) moved out of Quick start into a dedicated ## Feature deep-dives section.
  • Golden flow promoted to its own ## Try the full flow section; Quick start ends at the smoke check.
  • Admin-authorization blockquote promoted to an ### Admin authorization subsection under Architecture.
  • ## Status renamed to ## Documentation and moved below the visitor-facing sections.

2. Prose pass

  • Em-dash-heavy telegraphic style rewritten into plain sentences (37 → 3 em-dashes in prose); fragments expanded into full sentences. Facts, links, and anchors unchanged.
  • Dense sections bulletized: the four feature deep-dives, admin authorization, and the golden-flow description (now a 10-step list matching the 10 NDJSON output lines).
  • Deep-dive bodies wrapped in <details> with headings and a one-line summary kept outside, so TOC/intro-bullet anchors still land correctly.
  • "What's in the box" updated to shipped scope — the one place existing prose is edited, please sanity-check: "Two distribution models" → "Three" (adds ADT), "state machine for both" → "for the two code-based models", plus new bullets for window enforcement, auto-approve, and the admin detail-page shell + announcements.

3. New walkthrough GIF

  • Replaced with a new recording (960×540, 8.8 MB): admin creates an ADT-distribution playtest with auto-approve enabled, player signs up, is approved instantly, and receives the ADT build download link. Alt text updated to match.

Verification

  • All TOC anchors + internal # links validated against generated GitHub heading anchors (script-checked).
  • All relative file links verified to exist on disk.
  • Docs-only change — no code, tests, or generated artifacts touched.

Pure restructuring pass — every sentence survives; only headings,
positions, and the intro bullets change:

- Add a table of contents after the intro.
- Move the M4/M5.A/M5.B/M5.C milestone paragraphs out of Quick start
  into a dedicated 'Feature deep-dives' section (bold leads become
  headings; prose verbatim).
- Promote the golden flow to its own 'Try the full flow' H2 so Quick
  start ends at the smoke check.
- Promote the admin-authorization blockquote to an 'Admin
  authorization' subsection under Architecture.
- Rename 'Status' to 'Documentation' and move the sources-of-truth
  table below the visitor-facing sections (Quick start, Deploy, Game
  integration).
- Update 'What's in the box' to match shipped scope: distribution
  models two -> three (ADT), plus bullets for window enforcement,
  auto-approve, and the admin detail-page shell + announcements, each
  linking to its deep-dive.
…-dives

- Rewrite the em-dash-heavy telegraphic style into plain sentences
  (37 -> 3 em-dashes in prose); expand fragments into full sentences.
- Bulletize the dense parts: the four feature deep-dives, the admin
  authorization block, and the golden-flow description (now a 10-step
  list matching the 10 NDJSON output lines).
- Wrap each deep-dive body in <details>/<summary> with the heading and
  a one-line summary kept outside, so TOC and intro-bullet anchors
  still land correctly (GitHub does not auto-expand closed <details>
  on fragment navigation).
- No facts, links, or anchors changed.
New recording: admin creates an ADT-distribution playtest with
auto-approve enabled, player signs up, is approved instantly, and
receives the ADT build download link. Alt text updated to match.
@anggorodewanto
anggorodewanto merged commit 0dab281 into AccelByte:main Jul 15, 2026
6 checks passed
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