Skip to content

docs(repo): rewrite the guides and READMEs - #126

Merged
skydread1 merged 2 commits into
developfrom
docs/overhaul
Aug 7, 2026
Merged

docs(repo): rewrite the guides and READMEs#126
skydread1 merged 2 commits into
developfrom
docs/overhaul

Conversation

@skydread1

@skydread1 skydread1 commented Aug 7, 2026

Copy link
Copy Markdown
Member
  • New guides: docs/architecture.md, docs/bootstrap.md, docs/development.md, docs/nos-cli.md.
  • Rewritten guides: why-magic, deterministic compilation and the drift check, CLR dependency files, native assembly loading, porting, cross-platform Clojure, Unity integration.
  • Each topic has one owning doc and the others link to it instead of restating it.
  • Root and component READMEs follow one structure with uniform attribution blocks, keeping Ramsey Nasser's original tutorials and name etymologies.
  • Tooling ride-along: bb dev-compiler runs two bootstrap passes, the MSBuild targets rebuild unconditionally, and bb check-drift drops its skip-dlls mode.
  • bb.edn task docstrings are one sentence per line, scoped to what each task does.

…p check-drift skip-dlls

dev-compiler runs two bootstrap passes, only the second being the fixpoint, and the MSBuild targets no longer guard on output existence, which kept a stale host after a C# edit.

check-drift's skip-dlls mode is removed: it ran the same regeneration as the full check, reverted freshly refreshed DLLs, and its source-hash grading is blind to runtime changes that move bytes. Task docstrings reflowed to one sentence per line.
New guides: architecture, bootstrap, development, the nos CLI. Rewritten: why-magic, deterministic compilation, CLR dependency files, native assembly loading, porting, cross-platform Clojure, Unity integration. One owner per topic, cross-linked instead of restated.

Root and component READMEs redone on one structure with uniform attribution, keeping Ramsey Nasser's original tutorials and etymologies.
@skydread1 skydread1 self-assigned this Aug 7, 2026
@skydread1
skydread1 merged commit fac1de3 into develop Aug 7, 2026
1 check passed
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