This repository was archived by the owner on Dec 19, 2025. It is now read-only.
This repository was archived by the owner on Dec 19, 2025. It is now read-only.
Add top-level documentation #4
Description
Summary
Add documentation for the Koi programming language in general. This should ideally be in the README.md file in the project root folder. It may also be helpful to explore what each crate is responsible for at a surface level.
The documentation should include all (but not limited to) the following (ordered by importance):
- Summary of the project as a whole
- Syntax grammar
- Technical documentation for each crate
- Building and testing instructions
- Links to related projects (e.g. the VSCode extension)
- Project feature list and road map
- Changelog