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

Planning: Organizing docs for dark-next #380

Open
StachuDotNet opened this issue Jan 16, 2024 · 0 comments
Open

Planning: Organizing docs for dark-next #380

StachuDotNet opened this issue Jan 16, 2024 · 0 comments

Comments

@StachuDotNet
Copy link
Member

StachuDotNet commented Jan 16, 2024

This repo, and the resultant docs site, is focused on dark-classic.
We need to make the division between the doc sections a bit more clear, and plan out what docs we want for -next.

Here are some semi-organized thoughts towards such:

  • how-to docs
  • discussion docs
    • how to write functional programs in darklang
      • immutability, how to model, options/results/howtodo error checking, how to do loopps
    • error handling
    • what typename to use is different places (enum match pattern, )
    • how dark is different from ... + cheatsheet (syntax and semantics)
      • js, ts, python rust
      • elm, ocaml, f#, haskell (less important)
    • how to do json stuff
    • how to do db stuff
  • reference docs
    • language
    • for each tool
    • changelog/release notes
    • library docs (e.g. docs.rs)
@StachuDotNet StachuDotNet changed the title Create basic docs for dark-next Planning: Organizing docs for dark-next Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant