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.

Sign up for GitHub

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

Jump to bottom

Write more complete documentation, including hints on usage #57

Closed
MaddyGuthridge opened this issue May 21, 2024 · 0 comments
Closed

Write more complete documentation, including hints on usage #57

MaddyGuthridge opened this issue May 21, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@MaddyGuthridge
Copy link
Member

  • Make use of Sim's original pyhtml cheatsheet.
  • Basically I want something similar but more complete and organised. Perhaps also document common issues with the type system.
  • Build docs with mkdocs
  • Use GitHub pages deployment for docs site (and also provide within exam?)
@MaddyGuthridge MaddyGuthridge added the enhancement New feature or request label May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MaddyGuthridge