Skip to content

docs: update README with improved writing and documentation references - #158

Merged
thsfranca merged 1 commit into
mainfrom
docs/update-readme
Mar 22, 2026
Merged

docs: update README with improved writing and documentation references#158
thsfranca merged 1 commit into
mainfrom
docs/update-readme

Conversation

@thsfranca

Copy link
Copy Markdown
Owner

Summary

  • Add Fibonacci and records examples alongside Hello World
  • Reference all four design documents (language design, compiler architecture, dependency management, MVP)
  • Reorganize into clearer sections: Examples, Usage, Architecture, Documentation
  • Remove cargo build from Usage section (moved to Development)
  • Mention test count (551 tests) in current status

Test plan

  • Verify all documentation links resolve correctly
  • Confirm README renders properly on GitHub

Add dependency management doc reference, multiple code examples,
clearer architecture section, and reorganize content for readability.
@thsfranca
thsfranca enabled auto-merge (squash) March 22, 2026 00:19
@thsfranca
thsfranca merged commit ef8c95a into main Mar 22, 2026
2 checks passed
@thsfranca
thsfranca deleted the docs/update-readme branch March 22, 2026 00:19
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