docs: cohesion pass, Datastar framing, drop council/design records#108
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documentation cohesion sweep across the whole
docs/set plus repo-root cleanup.Docs
internal/examples/chatclusterdeployment. Cross-linked fromdistributed-state.md.examples.mdandshowcase.mdboth declarednav_order: 3(undefined menu order) — moved Showcase last.StateAppSlicewhile claiming the code isinternal/examples/chat, which actually usesStateAppEvents. Reframed as the simpler shape with a forward link to Distributed state.index,why-via,glossary,reactive-state; describe Datastar plainly as the browser runtime that keeps the page reactive and updates it in place.slice→field, matching the event-sourced example).Cleanup
critique-council.md,design-council.md, anddesign/— multi-agent process transcripts, not part of the published docs site.(council T*-*)provenance tags, kept the technical rationale) and theHYGIENE.mdpointer.Notes
go build ./...andgo vetpass.state-backplanestring is a valid docs-site anchor (production#state-backplane-under-load), not the deleted file.