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

Move docs from Django to website #72

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

JasonGrace2282
Copy link
Member

@JasonGrace2282 JasonGrace2282 commented Aug 11, 2024

Since we have our website there's really no reason to host docs on Tin itself anymore.
I did try to improve the docs wherever possible, especially by adding more examples of graders.

TODO

  • remove docs from Django
  • organize the docs in the sphinx builds
  • add more examples for graders
    • Fibonacci example
    • File IO
    • an example with autorunning submissions with a specifically named function

@JasonGrace2282 JasonGrace2282 added the area/documentation Improvements or additions to documentation label Aug 11, 2024
@JasonGrace2282 JasonGrace2282 self-assigned this Aug 11, 2024
@JasonGrace2282 JasonGrace2282 marked this pull request as ready for review September 12, 2024 13:09
@JasonGrace2282 JasonGrace2282 requested a review from a team as a code owner September 12, 2024 13:09
Copy link
Member

@krishnans2006 krishnans2006 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huge PR! The accessibility improvements are insane, and this should drastically lower Tin's barrier to entry!

Here are some minor comments from just looking at the diffs.

Hopefully I'll be able to run a quick test on the code relatively soon, to make certain that these (very minor) code changes didn't accidentally break something.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The extra comments and organization here are great!

docs/source/usage/graders/writing_graders.rst Outdated Show resolved Hide resolved
docs/source/usage/graders/writing_graders.rst Outdated Show resolved Hide resolved
tin/templates/base.html Outdated Show resolved Hide resolved
tin/templates/base.html Outdated Show resolved Hide resolved
Co-authored-by: Krishnan Shankar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants