oakc
oakc copied to clipboard
More documentation
@adam-mcdaniel
Please add more documentation for Oak.
I plan to as soon as possible, expect a PR very soon.
I'm starting to get familiar with the code base. Any ideas on how to structure the documentation? Would be a good idea to set up some sort of skeleton so multiple people can fill the gaps
@kevinramharak I think we should structure it by
- Syntax
- Type system
- Expressions
- Constants
- Functions
- Structures
- Compiler Directives
I think this would be the most intuitive way to structure it. Start with the atomic things, like syntax, and the type system for expressions, and move up to higher level abstractions and compiler directives.
I have a tour.md
in the works right now to lightly cover documentation until we beef up the docs a bit.