Skip to content

docs: focus the site on the language, one door and seven pages - #9

Merged
josemontesdeoca merged 5 commits into
mainfrom
chore/language-first-docs
Jul 28, 2026
Merged

docs: focus the site on the language, one door and seven pages#9
josemontesdeoca merged 5 commits into
mainfrom
chore/language-first-docs

Conversation

@josemontesdeoca

@josemontesdeoca josemontesdeoca commented Jul 28, 2026

Copy link
Copy Markdown
Member

The docs site now covers the language and nothing else, as one door and seven pages: what OpenProse is, setup via the skill, declaring outcomes, contracts, ProseScript, the typed image, and the harness seam.

Structure

  • The harness sections (/reactor, /sdk, /cli, /reactor-devtools) are removed. That reference lives with the packages in the openprose/prose repo, and the old routes redirect there. The redirects are temporary on purpose: the routes may host docs again when the harness documentation is reworked.
  • The section folder is gone too: with one topic left it forced every visitor through two overview pages with the same job. Pages live at the root in learning order, and every old /openprose/* link redirects to its new home.

Reading path

  • Setup teaches the skill path: install, author a complete first contract, run that exact file, and where to file an issue when something breaks. Agent-filed issues are first-class here, same as the main repo.
  • The language pages keep the seam honest: fingerprints, memoization, and receipts are one host's runtime, not language features. Reactor is named once, as one such host, pointing at the repo for the harness reference.

Rendering

  • The contracts page's program panels no longer inherit the inline-code chip styling that painted a box behind every line.
  • Markdown fences soft-wrap on narrow viewports so their sentences stay readable; alignment-sensitive fences keep their horizontal scroll.
  • Prose no longer renders literal double hyphens where a dash was meant, and the one four-column table folds its overflow column into the paragraph below it.
  • The theme toggle is removed: the site is light-only by design and the control did nothing.

Checks: typecheck, tests, lint, spell, the em-dash gate, and the internal link checker all pass.

@josemontesdeoca
josemontesdeoca requested a review from irl-dan July 28, 2026 15:32
@josemontesdeoca josemontesdeoca self-assigned this Jul 28, 2026
@josemontesdeoca
josemontesdeoca marked this pull request as ready for review July 28, 2026 15:32
Setup now hands the reader a complete contract before asking them to run
one, and says where to file an issue when something breaks. The root door
stops duplicating the language overview (the section is retitled "The
language"), the seam page defines its state terms abstractly and names
Reactor once, pointing at the repo for the harness reference.
The section folder was scaffolding from when the site had six sections;
with one topic left it forced every visitor through two overview pages
with the same job. Pages now live at the root in learning order, with
Setup right after the door. The section index is gone (its content
already lived on the pages it summarized) and every old /openprose/*
link redirects to its new home.
@josemontesdeoca
josemontesdeoca force-pushed the chore/language-first-docs branch from 2c1a9a8 to 8ce7589 Compare July 28, 2026 18:27
The contracts page's two program panels inherited the inline-code chip
styling from the typography layer, painting a cream box behind every
line; the panel now opts out. Markdown fences soft-wrap on narrow
viewports so their sentences stay readable (the fence language is now
exposed as an attribute for styling), the one four-column table drops
its overflow column into the paragraph below it, and prose across the
site stops rendering literal double hyphens where a dash was meant.
The theme toggle is gone: the site is light-only by design and the
control did nothing.
@josemontesdeoca josemontesdeoca changed the title docs: focus the site on the language docs: focus the site on the language, one door and seven pages Jul 28, 2026
The fence-language styling hook becomes the built-in addLanguageClass
flag; the custom transformer was silently replacing the default code
notation transformers. The redirect table collapses to one entry per
archived section (a wildcard source also matches its bare prefix), the
mobile soft-wrap now covers the program panels too, and the theme
switch is disabled where the rest of the layout config lives.
@josemontesdeoca
josemontesdeoca merged commit ff5f002 into main Jul 28, 2026
7 checks passed
@josemontesdeoca
josemontesdeoca deleted the chore/language-first-docs branch July 28, 2026 20:13
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