-
Notifications
You must be signed in to change notification settings - Fork 20
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
docs/wiki/guidelines #137
Labels
documentation
Improvements or additions to documentation
Comments
commenting to note that we're hashing out error-handling strategies, which is a topic that'll need a wiki page eventually. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Need to write this one down somewhere so I (hopefully) stop forgetting.
The documentation is in dire need of an overhaul. The wiki has only a brief explanation of environment variables!
The README needs an overhaul; it should be significantly more minimal and link heavily to a fleshed-out wiki describing setup and documenting the main points of every individual cog. Workflow runs also need documentation, keeping in mind our "target audience" is a 1001 student who hasn't touched static typesystems yet.
It'd also be good to get contribution/security/whatever guidelines and PR/issue templates setup, per github's recommendations for community repos.
The text was updated successfully, but these errors were encountered: