oakc icon indicating copy to clipboard operation
oakc copied to clipboard

More documentation

Open ghost opened this issue 3 years ago • 4 comments

@adam-mcdaniel

Please add more documentation for Oak.

ghost avatar Aug 27 '20 00:08 ghost

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

adam-mcdaniel avatar Aug 27 '20 01:08 adam-mcdaniel

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 avatar Aug 27 '20 21:08 kevinramharak

@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 avatar Sep 02 '20 07:09 adam-mcdaniel

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

adam-mcdaniel avatar Sep 02 '20 07:09 adam-mcdaniel