docs: add roadmap, rationale, and installation design - #159
Merged
Conversation
added 7 commits
March 23, 2026 01:59
Add roadmap-rationale.md with design constraint analysis and parametric polymorphism gap analysis. Add roadmap.md tracking all planned work items with current status. Add update-roadmap skill for reviewing roadmap status before commits. Update pre-commit-checks skill to include mandatory roadmap review step.
…esign §5.1 claimed Hindley-Milner inference, but the implementation uses explicit parameter annotations with local body inference. Updated §5.1, §5.5, and the glossary to match the actual design direction and roadmap recommendation.
…rait removal to roadmap Replace broken expression-level try macro with try/catch design that expands binding lists into nested match. Add pattern match exhaustiveness checking rationale. Add trait removal rationale and remove traits from language-design.md grammar and type system sections.
Add step to update-roadmap skill that cross-checks roadmap-rationale.md and language-design.md for items not yet tracked in the roadmap.
Reorganize sections to follow the reader's journey: what it is, what code looks like, what it can do, how to get started, how it works. Add prerequisites, replace all-Done status table with architecture table, link to examples/ directory, and use a documentation table for doc links.
- Update compiler-architecture.md: replace 500-line split rule with concept-based splitting, add summary extraction to pipeline, update Go generics note for Go 1.26, expand DX table with formatter/source mapping/Go detection/editor tooling, update excluded items - Update language-design.md: fix Go generics limitation note, expand concurrency section with select semantics and structured concurrency reference, add Gleam/Coalton to Prior Art, add design decisions for mutability, closure capture, Error type, JsonValue, runtime failures - Update dependency-management.md: add summary extraction step to resolution flow, fix step numbering, add vex tidy to Not in Scope - Update roadmap.md: add Diagnostics section with unused bindings/imports - Update roadmap-rationale.md: add §12 unused bindings/imports analysis - Update mvp.md status from Active to Complete - Update README.md with roadmap doc links - Update cursor rules and skills to use concept-based file splitting
…ibution plan Define the full installation architecture in docs/installation.md: curl installer script with auto-PATH setup, release pipeline for 5 cross-compiled targets, Go toolchain detection, and future distribution channels (Homebrew, APT, Scoop). Add §13 to roadmap-rationale.md and Installation section to roadmap.md.
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
1 participant
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.
Summary
docs/roadmap.md) tracking all planned features with status, priorities, and rationale referencesdocs/roadmap-rationale.md) with state-of-the-art analysis and trade-off discussion for 13 areas: parametric polymorphism, error propagation, exhaustiveness checking, trait removal, structured concurrency, formatter, source mapping, Go detection, summary extraction, LSP, tree-sitter, unused warnings, and installation/distributiondocs/installation.md) covering the release pipeline, curl installer with auto-PATH, Go toolchain detection, and future distribution channelsTest plan