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

docs/wiki/guidelines #137

Open
andrewj-brown opened this issue Jul 13, 2023 · 1 comment
Open

docs/wiki/guidelines #137

andrewj-brown opened this issue Jul 13, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@andrewj-brown
Copy link
Member

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.

@andrewj-brown andrewj-brown added the documentation Improvements or additions to documentation label Jul 13, 2023
@andrewj-brown
Copy link
Member Author

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
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant