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 #100

Open
ngua opened this issue Feb 2, 2024 · 0 comments
Open

More documentation #100

ngua opened this issue Feb 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ngua
Copy link
Contributor

ngua commented Feb 2, 2024

I think we should work on improving the documentation for this project:

  • None of the packages in this project have readmes
  • The main readme doesn't really provide a high-level overview of using the language, what it's for, etc...
  • The current contents of the readme should probably be split into different docs, currently it's difficult to find information (there are long sections on the Nix part and Inferno's internals)
@ngua ngua added the documentation Improvements or additions to documentation label Feb 2, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant