[GH-ISSUE #985] docs(website): make guides and case studies easier to follow #371

Closed
opened 2026-10-15 18:24:23 +00:00 by bsakaguchi · 0 comments
Owner

Originally created by @N0zoM1z0 on GitHub (Oct 7, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/985

Originally assigned to: @N0zoM1z0 on GitHub.

The website's examples and figures explain the investigations well, but some entry headings are vague, several paragraphs repeat the same summary, and a few steps assume setup that the reader has not completed.

This review covers the pages outside the homepage, including the guides and the DX-Ball, Notion, and TH04 case studies.

Changes

  • Get started: use a direct setup heading, distinguish agent and CLI entry points, simplify setup terminology, and use an npx native-function example that does not assume an optional global installation.
  • Guides index: use direct headings for the guide list and setup link.
  • Native guide: name the sound-pan calculation in the heading, replace “A position becomes a sound,” and shorten generic investigation advice.
  • JavaScript & Electron guide: name the CSV export in the heading and explain the expected IPC result before its JSON field paths.
  • Browser guide: make the first command open the hosted Notes example, so it works without an unexplained local server; explain remote debugging directly and reduce repeated capture-versus-script summaries.
  • Showcases index: name the case studies directly and remove the generic investigation introduction.
  • DX-Ball: reduce repeated instructions/caller/constants summaries and make progress labels easier to understand. Keep the three REA query/result pairs, assembly-to-C comparison, and verification results.
  • Notion: use a direct clipboard heading, explain how the HTML ID connects to saved block data, and make Markdown tables an optional additional example. Keep source and probe details available in the evidence section.
  • TH04: replace internal terms such as “reviewed boundary,” “source owner,” and “target extent” with descriptions of the helper and the code section being checked. Keep detailed compiler checks in the evidence section.
  • README: replace the DX-Ball-only showcase link with a Showcases link to the case-study index.
  • Maintenance guide: document direct writing, page structure, figures, shared visual styles, evidence attribution, verification, and manual publication; link it from the website README and scoped agent instructions.
  • Figures and examples: keep terminology consistent with the page text and check that the examples, prompts, copying, downloads, and code-step interactions still work.

Validation

Check local links and site preparation, then review the pages at desktop and mobile widths. Verify the copy buttons, Notes ZIP, browser example, case-study step selectors, and collapsed evidence.

Preserve the existing design, homepage, prompts, code examples, and figures. Keep the distinctions between fresh REA results, source interpretation, and historical verification accurate. Pages publication remains manual.

Originally created by @N0zoM1z0 on GitHub (Oct 7, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/985 Originally assigned to: @N0zoM1z0 on GitHub. The website's examples and figures explain the investigations well, but some entry headings are vague, several paragraphs repeat the same summary, and a few steps assume setup that the reader has not completed. This review covers the pages outside the homepage, including the guides and the DX-Ball, Notion, and TH04 case studies. ## Changes - [x] **Get started:** use a direct setup heading, distinguish agent and CLI entry points, simplify setup terminology, and use an `npx` native-function example that does not assume an optional global installation. - [x] **Guides index:** use direct headings for the guide list and setup link. - [x] **Native guide:** name the sound-pan calculation in the heading, replace “A position becomes a sound,” and shorten generic investigation advice. - [x] **JavaScript & Electron guide:** name the CSV export in the heading and explain the expected IPC result before its JSON field paths. - [x] **Browser guide:** make the first command open the hosted Notes example, so it works without an unexplained local server; explain remote debugging directly and reduce repeated capture-versus-script summaries. - [x] **Showcases index:** name the case studies directly and remove the generic investigation introduction. - [x] **DX-Ball:** reduce repeated instructions/caller/constants summaries and make progress labels easier to understand. Keep the three REA query/result pairs, assembly-to-C comparison, and verification results. - [x] **Notion:** use a direct clipboard heading, explain how the HTML ID connects to saved block data, and make Markdown tables an optional additional example. Keep source and probe details available in the evidence section. - [x] **TH04:** replace internal terms such as “reviewed boundary,” “source owner,” and “target extent” with descriptions of the helper and the code section being checked. Keep detailed compiler checks in the evidence section. - [x] **README:** replace the DX-Ball-only showcase link with a Showcases link to the case-study index. - [x] **Maintenance guide:** document direct writing, page structure, figures, shared visual styles, evidence attribution, verification, and manual publication; link it from the website README and scoped agent instructions. - [x] **Figures and examples:** keep terminology consistent with the page text and check that the examples, prompts, copying, downloads, and code-step interactions still work. ## Validation Check local links and site preparation, then review the pages at desktop and mobile widths. Verify the copy buttons, Notes ZIP, browser example, case-study step selectors, and collapsed evidence. Preserve the existing design, homepage, prompts, code examples, and figures. Keep the distinctions between fresh REA results, source interpretation, and historical verification accurate. Pages publication remains manual.
bsakaguchi 2026-10-15 18:24:23 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#371
No description provided.