Skip to content

docs: cohesion pass, Datastar framing, drop council/design records#108

Merged
joaomdsg merged 1 commit into
mainfrom
docs/cohesion-and-council-cleanup
Jun 10, 2026
Merged

docs: cohesion pass, Datastar framing, drop council/design records#108
joaomdsg merged 1 commit into
mainfrom
docs/cohesion-and-council-cleanup

Conversation

@joaomdsg

Copy link
Copy Markdown
Member

What

Documentation cohesion sweep across the whole docs/ set plus repo-root cleanup.

Docs

  • production.md: new Horizontal scaling & affinity section — tells the scaling story (affinity for transport, backplane for state), explains why round-robin breaks a tab, calls out the sticky-cookie + tunnel-timeout essentials, and references the runnable internal/examples/chatcluster deployment. Cross-linked from distributed-state.md.
  • nav fix: examples.md and showcase.md both declared nav_order: 3 (undefined menu order) — moved Showcase last.
  • tutorial.md: it taught StateAppSlice while claiming the code is internal/examples/chat, which actually uses StateAppEvents. Reframed as the simpler shape with a forward link to Distributed state.
  • Datastar framing: dropped the "Alien Signals" jargon across index, why-via, glossary, reactive-state; describe Datastar plainly as the browser runtime that keeps the page reactive and updates it in place.
  • README: same Datastar framing; fixed the chat description (slicefield, matching the event-sourced example).

Cleanup

  • Deleted critique-council.md, design-council.md, and design/ — multi-agent process transcripts, not part of the published docs site.
  • Scrubbed the references they left behind: 6 source/test comments (dropped the (council T*-*) provenance tags, kept the technical rationale) and the HYGIENE.md pointer.

Notes

  • Code changes are comment-only; go build ./... and go vet pass.
  • The lone remaining state-backplane string is a valid docs-site anchor (production#state-backplane-under-load), not the deleted file.

Documentation cohesion sweep plus repo-root cleanup.

Docs:
- production.md: add "Horizontal scaling & affinity" section (affinity for
  transport, backplane for state) referencing the chatcluster example;
  cross-link from distributed-state.md.
- Fix nav_order collision (examples & showcase both 3); move showcase last.
- tutorial.md: stop claiming the StateAppSlice walkthrough *is*
  internal/examples/chat, which uses StateAppEvents — frame it as the simpler
  shape with a forward link to distributed state.
- Drop "Alien Signals" jargon across index/why-via/glossary/reactive-state;
  describe Datastar plainly as the browser runtime that keeps the page
  reactive and updates it in place.
- README: same Datastar framing; fix chat description ("slice" -> "field").

Cleanup:
- Delete critique-council.md, design-council.md, and design/ (process
  transcripts, not part of the docs site).
- Scrub the dangling references they left behind: 6 source/test comments
  (drop the council/T-* provenance tags, keep the rationale) and the
  HYGIENE.md pointer.

Comment-only code changes; build and vet pass.
@joaomdsg
joaomdsg merged commit 51eba95 into main Jun 10, 2026
6 checks passed
@joaomdsg
joaomdsg deleted the docs/cohesion-and-council-cleanup branch June 10, 2026 14:43
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