Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More documentation #78

Open
ghost opened this issue Aug 27, 2020 · 4 comments
Open

More documentation #78

ghost opened this issue Aug 27, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ghost
Copy link

ghost commented Aug 27, 2020

@adam-mcdaniel

Please add more documentation for Oak.

@adam-mcdaniel adam-mcdaniel added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 27, 2020
@adam-mcdaniel
Copy link
Owner

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

@kevinramharak
Copy link
Contributor

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
Copy link
Owner

@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
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants