From f13f84044be1bd18160f4845a739592219638862 Mon Sep 17 00:00:00 2001 From: zinc Date: Wed, 14 Oct 2026 09:28:59 +0000 Subject: docs: remove temporary notes and fix onboarding drift - delete TASKLIST.md and docs/design/handoff.md; the handoff content lives in README.md - move docs/BOOTSTRAP-OWNERSHIP.md to docs/history/ and index it in docs/history/README.md - point ONBOARD.md, docs/BORROW.md and the ticked TODO.md item at the new path - ONBOARD.md section 9 no longer mentions TASKLIST.md - ONBOARD.md section 3 and 4 markers are now `// ...` (line comments lost their colon) verified from a clean build: make clean, make (fixpoint 376903 words), the section 0-7 commands (section 4 after the marker fix), and the rejection suites. make check was started but did not complete (stopped before it finished). --- ONBOARD.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'ONBOARD.md') diff --git a/ONBOARD.md b/ONBOARD.md index 7b0c045..a0ed367 100644 --- a/ONBOARD.md +++ b/ONBOARD.md @@ -70,7 +70,7 @@ explain why `include rt;` is required before `rt.put_n`. ## 3. ownership, the analyzer's view -read `docs/BORROW.md`, then `docs/BOOTSTRAP-OWNERSHIP.md` (how two missing rules +read `docs/BORROW.md`, then `docs/history/BOOTSTRAP-OWNERSHIP.md` (how two missing rules once stopped the compiler compiling itself). run the rejection suites and read a few of the fixtures, each of which starts with the message it expects: @@ -81,7 +81,7 @@ bash tests/runerr.sh build/bin/zy tests/langerrors ``` in `src/compiler/compiler.zc`, find the block that starts at -`//: the rules below are the heart of the analyzer` and read `recast`, +`// the rules below are the heart of the analyzer` and read `recast`, `argcheck`, `assigncheck` and `retcheck`, then `exit_vars` and the `lend_*` helpers. @@ -95,7 +95,7 @@ does to them. overview. read the overview, then use the section markers to navigate: ```sh -grep -n "^//: ----" src/compiler/compiler.zc +grep -n "^// ----" src/compiler/compiler.zc ``` read in this order: interning and symbols, the lexer (`lex1`), expressions @@ -171,8 +171,8 @@ headers for the llvm section. ## 9. history and open work -`docs/history/README.md` is the scrapbook of earlier stages, `TODO.md` the -maintenance checklist, and `TASKLIST.md` the record of past requests. read the +`docs/history/README.md` is the scrapbook of earlier stages and `TODO.md` the +maintenance checklist. read the open items in `TODO.md` last: by then each one should point at code you have seen. -- cgit v1.2.3