⏺ CONTRIBUTING.md is clean — no issues. It covers process only (shell…#356
⏺ CONTRIBUTING.md is clean — no issues. It covers process only (shell…#356
Conversation
… commands, PR workflow, code style), contains no Seq code examples, and nothing that could be stale. That completes the full documentation review. Here's a summary of all 16 tasks: ┌─────┬─────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────────────────────┐ │ # │ File │ Changes │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 1 │ README.md │ Fixed seqc commands, removed stale limitations, spawn API │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 2 │ language-guide.md │ Many word name fixes, removed future-work sections │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 3 │ TYPE_SYSTEM_GUIDE.md │ Bool/Int corrections, removed pre-impl sections │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 4 │ TCO_GUIDE.md │ Fixed operator names, musttail accuracy │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 5 │ STDLIB_REFERENCE.md │ Signatures, word names, removed placeholders │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 6 │ BATTERIES_INCLUDED.md │ Major rewrite — removed all pre-implementation content │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 7 │ FFI_GUIDE.md │ string.length, i.>, removed future-work │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 8 │ GRAMMAR.md │ Added Yield effect annotation, fixed i.divide example, naming conventions │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 9 │ GLOSSARY.md │ CSP example (chan.make), fixed cond syntax entirely │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 10 │ INCLUDE_SYSTEM.md │ Removed to-do list, fixed stdlib lookup description, io.write-line │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 11 │ OBSERVABILITY_GUIDE.md │ SEQ_REPORT=words, removed internal C symbols │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 12 │ TESTING_GUIDE.md │ i.+, drop after i./ calls │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 13 │ ARCHITECTURE.md │ Variant API, JSON tags, factorial, concurrency API, TCO link, removed false limitation │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 14 │ EXAMPLES.md │ i.mod, removed dev-notes section, string escapes, YAML API names, concurrency API, seqc build │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 15 │ MIGRATION_4.0.md + MIGRATION_3.0.md │ No changes needed │ ├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤ │ 16 │ CONTRIBUTING.md │ No changes needed │ └─────┴─────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────────────────┘
Documentation ReviewThis is a solid documentation sweep that brings the docs in line with the 4.0 API. The changes are consistently in the right direction: removing stale roadmap content, correcting operator/word names, and fixing type signatures throughout. A few things worth addressing before merge: Issues1. Incomplete symbol-notation migration in Tags 0-2 are updated to use
Should be 2. Possible forward reference in The updated text says:
If 3. Minor: The new signature Positive highlights
|
Issue 1 — JSON tags 3–5: Agree. That was a genuine miss — I updated 0–2 to :Symbol notation but forgot 3–5. Fixed now. Issue 2 — os.home-dir / os.path-join: Disagree with the concern. Both are confirmed builtins in builtins.rs (lines 524 and 529). No forward reference. Issue 3 — cond spacing: Agree. [T--T Bool] was inconsistent with the [T -- U] spacing used by list.map, list.filter, list.fold. Fixed to [T -- T Bool] / [T -- T].
Documentation Review — PR #356This is a documentation-only PR updating 14 files (275 additions, 1051 deletions) to align docs with the current state of the language and project structure. Overall this is high-quality, well-scoped work. Notes below. Strengths
Issues / Questions1. PR title looks AI-generated The title '⏺ CONTRIBUTING.md is clean — no issues...' appears to be the output of an AI code review agent, not a human-authored commit message. Consider updating to something like: docs: sync all guides to current API (v4.0 naming conventions). 2. Placeholder identifier in ARCHITECTURE.md concurrency example In the concurrency section, chan-id is used as a placeholder name but looks like a real Seq word to newcomers. Consider matching the style in language-guide.md which shows actual stack flow, or add a comment clarifying it is a placeholder. 3. chan.yield vs yield — verify the word name ARCHITECTURE.md now documents chan.yield for cooperative yield, but this word does not appear in language-guide.md or the README. If the word is actually chan.yield, it should be consistent in the stdlib reference too. If it is still the bare yield word, this rename is incorrect. 4. STDLIB_REFERENCE.md drops primitive count without replacement Old: 152 primitives implemented in the runtime Removing a stale count is correct, but consider adding a note like see crates/compiler/src/builtins.rs for the canonical list so users know where to look. 5. BATTERIES_INCLUDED.md table lost the FFI Effort column silently The capability table dropped the FFI Effort column. If these capabilities are now implemented, noting them as available vs planned would help. If some are still planned, the column removal hides useful information. Minor Nits
Summary
Recommend verifying the chan.yield word name and updating the PR title before merging. The rest are suggestions. Good cleanup overall. |
… commands, PR workflow, code style), contains no Seq code examples, and nothing that
could be stale.
That completes the full documentation review. Here's a summary of all 16 tasks:
┌─────┬─────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────────────────────┐
│ # │ File │ Changes │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 1 │ README.md │ Fixed seqc commands, removed stale limitations, spawn API │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 2 │ language-guide.md │ Many word name fixes, removed future-work sections │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 3 │ TYPE_SYSTEM_GUIDE.md │ Bool/Int corrections, removed pre-impl sections │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 4 │ TCO_GUIDE.md │ Fixed operator names, musttail accuracy │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 5 │ STDLIB_REFERENCE.md │ Signatures, word names, removed placeholders │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 6 │ BATTERIES_INCLUDED.md │ Major rewrite — removed all pre-implementation content │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 7 │ FFI_GUIDE.md │ string.length, i.>, removed future-work │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 8 │ GRAMMAR.md │ Added Yield effect annotation, fixed i.divide example, naming conventions │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 9 │ GLOSSARY.md │ CSP example (chan.make), fixed cond syntax entirely │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 10 │ INCLUDE_SYSTEM.md │ Removed to-do list, fixed stdlib lookup description, io.write-line │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 11 │ OBSERVABILITY_GUIDE.md │ SEQ_REPORT=words, removed internal C symbols │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 12 │ TESTING_GUIDE.md │ i.+, drop after i./ calls │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 13 │ ARCHITECTURE.md │ Variant API, JSON tags, factorial, concurrency API, TCO link, removed false limitation │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 14 │ EXAMPLES.md │ i.mod, removed dev-notes section, string escapes, YAML API names, concurrency API, seqc build │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 15 │ MIGRATION_4.0.md + MIGRATION_3.0.md │ No changes needed │
├─────┼─────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ 16 │ CONTRIBUTING.md │ No changes needed │
└─────┴─────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────────────────┘