adam-mcdaniel/oakc

More documentation

Opened this issue · 4 comments

Deleted user commented

@adam-mcdaniel

Please add more documentation for Oak.

adam-mcdaniel commented

I plan to as soon as possible, expect a PR very soon.

kevinramharak commented

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

adam-mcdaniel commented

@kevinramharak I think we should structure it by

  1. Syntax
  2. Type system
    • Expressions
    • Constants
    • Functions
    • Structures
  3. 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.

adam-mcdaniel commented

I have a tour.md in the works right now to lightly cover documentation until we beef up the docs a bit.