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

Better docs #108

Closed
2 of 6 tasks
jdabtieu opened this issue Jun 6, 2021 · 1 comment
Closed
2 of 6 tasks

Better docs #108

jdabtieu opened this issue Jun 6, 2021 · 1 comment
Assignees
Labels
discussion New feature or request docs Improvements or additions to documentation priority low Nice-to-have, but not required

Comments

@jdabtieu
Copy link
Owner

jdabtieu commented Jun 6, 2021

While I was looking at a certain problem setters quiz and scrolling through that site's docs, I realized two things:

  1. The docs are awful at describing the functionality of the site
  2. Our docs are awful at describing the functionality of CTFOJ

There are some massive improvements we need to make to our docs (and related things). Here's a list of everything I can think of right now:

  • INSTALL.sh should use python application.py instead of export FLASK_APP=application.py and flask run
  • Install script should recommend the use of a venv, in both manual installation and the INSTALL.sh
  • Documentation for how the database and filesystem store info does not exist
  • Most site functions don't have documentation
    • Non-intuitive site functions don't have documentation (e.g. what does min & max point value mean in the context of dynamically scored problems?)
  • Update API documentation for v4

The addition & improvement of our docs will make it easier for users to navigate the site functionality (especially admin functionality) and for developers looking to contribute but cannot find anything to ease any confusion about the code/database

@jdabtieu jdabtieu added docs Improvements or additions to documentation discussion New feature or request priority normal Important, but not urgent labels Jun 6, 2021
@slightlyskepticalpotat
Copy link
Collaborator

todo for myself: wiki page describing how to customise the look and functionality of an install.

@jdabtieu jdabtieu self-assigned this Aug 23, 2021
@jdabtieu jdabtieu added priority low Nice-to-have, but not required and removed priority normal Important, but not urgent labels Mar 6, 2023
@jdabtieu jdabtieu mentioned this issue May 15, 2023
23 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion New feature or request docs Improvements or additions to documentation priority low Nice-to-have, but not required
Projects
None yet
Development

No branches or pull requests

2 participants