[PR #989] [MERGED] docs(website): clarify guides and case studies #2558

New issue

Closed

opened 2026-10-17 21:07:33 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-17 21:07:33 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/989
Author: @N0zoM1z0
Created: 10/7/2026
Status: ✅ Merged
Merged: 10/7/2026
Merged by: @N0zoM1z0

Base: main ← Head: docs/website-clearer-guides

📝 Commits (3)

166c13f docs(website): clarify guides and case studies
55799aa docs(website): credit the website design principle
efb4238 docs(website): share the design principle across authoring docs

📊 Changes

16 files changed (+497 additions, -288 deletions)

View changed files

📝 README.md (+1 -1)
➕ website/AGENTS.md (+23 -0)
📝 website/README.md (+9 -1)
📝 website/figures.md (+8 -0)
📝 website/public/assets/figures/dx-ball-sound-pan-investigation.svg (+3 -3)
📝 website/public/assets/styles.css (+2 -2)
📝 website/public/get-started/index.html (+125 -120)
📝 website/public/guides/browser/index.html (+14 -15)
📝 website/public/guides/index.html (+8 -10)
📝 website/public/guides/javascript/index.html (+15 -13)
📝 website/public/guides/native/index.html (+7 -13)
📝 website/public/showcase/dx-ball/index.html (+4 -18)
📝 website/public/showcase/index.html (+8 -8)
📝 website/public/showcase/notion/index.html (+50 -65)
📝 website/public/showcase/th04/index.html (+21 -19)
➕ website/style-guide.md (+199 -0)

📄 Description

Several guides use broad headings and repeat their summaries, making the main example harder to follow. This change names each task directly, keeps Notion's clipboard investigation in the main reading path, and moves the Markdown example and longer provenance into expandable details. The browser guide now opens the hosted example, and the first native CLI query works without a global install.

The existing figures, prompts, source excerpts and comparison controls remain the teaching material. Provider details now fit narrow screens. The repository README links to all Showcases, and the website authoring docs share a signed design principle: a good website is like a good paper—easy to follow, clear and concise, with a clean, refined presentation. A new style guide and scoped AGENTS.md explain how to maintain that approach.

Closes #985.

Validation:

python3 scripts/prepare-website.py and python3 scripts/verify-website.py: 12 HTML pages, 183 local references, SVG XML, the six-file ZIP and the sole manual Pages publisher.
Oxfmt checks and git diff --check; npm run check:fast with Node.js 24.18.0.
Browser checks at both / and /rea/: 24 routes, 68 copy buttons, 20 comparison steps, two CSV exports, two ZIP downloads and eight viewport widths from 320px to 1440px.
Existing code excerpts, expanded details, keyboard access, no-JavaScript content, continuous cursor animation and reduced motion checked.

Existing analysis and compiler-check evidence is retained; real native-provider verification and compiler replay were not rerun for these copy and layout changes. The homepage content and publication triggers are unchanged.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/989 **Author:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Created:** 10/7/2026 **Status:** ✅ Merged **Merged:** 10/7/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `docs/website-clearer-guides` --- ### 📝 Commits (3) - [`166c13f`](https://github.com/morluto/rea/commit/166c13fa9e964856fc55c0315a0c4e59a05f68df) docs(website): clarify guides and case studies - [`55799aa`](https://github.com/morluto/rea/commit/55799aa0c8a2a78459925ecb1f07f6a8450d1b0e) docs(website): credit the website design principle - [`efb4238`](https://github.com/morluto/rea/commit/efb423864654aba78f2a030b580e06a17b5df926) docs(website): share the design principle across authoring docs ### 📊 Changes **16 files changed** (+497 additions, -288 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+1 -1) ➕ `website/AGENTS.md` (+23 -0) 📝 `website/README.md` (+9 -1) 📝 `website/figures.md` (+8 -0) 📝 `website/public/assets/figures/dx-ball-sound-pan-investigation.svg` (+3 -3) 📝 `website/public/assets/styles.css` (+2 -2) 📝 `website/public/get-started/index.html` (+125 -120) 📝 `website/public/guides/browser/index.html` (+14 -15) 📝 `website/public/guides/index.html` (+8 -10) 📝 `website/public/guides/javascript/index.html` (+15 -13) 📝 `website/public/guides/native/index.html` (+7 -13) 📝 `website/public/showcase/dx-ball/index.html` (+4 -18) 📝 `website/public/showcase/index.html` (+8 -8) 📝 `website/public/showcase/notion/index.html` (+50 -65) 📝 `website/public/showcase/th04/index.html` (+21 -19) ➕ `website/style-guide.md` (+199 -0) </details> ### 📄 Description Several guides use broad headings and repeat their summaries, making the main example harder to follow. This change names each task directly, keeps Notion's clipboard investigation in the main reading path, and moves the Markdown example and longer provenance into expandable details. The browser guide now opens the hosted example, and the first native CLI query works without a global install. The existing figures, prompts, source excerpts and comparison controls remain the teaching material. Provider details now fit narrow screens. The repository README links to all Showcases, and the website authoring docs share a signed design principle: a good website is like a good paper—easy to follow, clear and concise, with a clean, refined presentation. A new style guide and scoped AGENTS.md explain how to maintain that approach. Closes #985. Validation: - `python3 scripts/prepare-website.py` and `python3 scripts/verify-website.py`: 12 HTML pages, 183 local references, SVG XML, the six-file ZIP and the sole manual Pages publisher. - Oxfmt checks and `git diff --check`; `npm run check:fast` with Node.js 24.18.0. - Browser checks at both `/` and `/rea/`: 24 routes, 68 copy buttons, 20 comparison steps, two CSV exports, two ZIP downloads and eight viewport widths from 320px to 1440px. - Existing code excerpts, expanded details, keyboard access, no-JavaScript content, continuous cursor animation and reduced motion checked. Existing analysis and compiler-check evidence is retained; real native-provider verification and compiler replay were not rerun for these copy and layout changes. The homepage content and publication triggers are unchanged. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-17 21:07:33 +00:00

closed this issue
added the
pull-request
label

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#2558

No description provided.

Rows
Columns