zom-lang/zom

Transform documentation to RFC and document the Compiler

Opened this issue · 2 comments

Larsouille25 commented

To clarify and standardize how Zom work, I've created the repository zom-lang/rfcs that contain all document, but we need to wrote all RFC.

Needs to RFC :

  • Functions, RFC-0001, tracking issue #40
  • var & const, RFC-0002
  • Primitive types & values, RFC-0003
  • Operator, RFC-0004
  • Control Flow : if, else if, else; RFC-0005
  • for loop & while loop & loop, RFC-0006
  • comments, RFC-0007, tracking issue #14
  • at the end, delete /docs/lang/ and its content.

Mark as done when the PR is merged.

=> see zom-lang/rfcs#9 so, before writing the docs

  • create a branch named feat/docs-compiler
  • delete all the content of docs/
  • make the next steps inside this branch
  • after make a pr etc..

After, document how the compiler works, with markdown document and graphs if needed, use MdBook:

  • Keywords : strict, reserved, weak
  • Syntax explenation
  • Project architecture explanation
  • Lexer
  • Parser
  • Intermediate Zom Representations ??
  • Zom Name Mangling
  • Typecheck
  • Code generation
  • Compilation
  • Linkage
  • zlib -> make an RFC for zlibs

Other docs to remake (in main branch, not in feat/docs-compiler)

Larsouille25 commented
  • Deletion of /docs/syntax.md because, now it's in /docs/lang/
Larsouille25 commented

There is a new repository to track the evolution of Zom with an RFC process, their will be all RFC that describe the entire lang and lib. So now, it needs to remake the doc but with an RFC.