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

Improve documentation #34

Open
gormaniac opened this issue Mar 27, 2024 · 0 comments
Open

Improve documentation #34

gormaniac opened this issue Mar 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@gormaniac
Copy link
Owner

gormaniac commented Mar 27, 2024 •
edited
Loading

The README is incredibly sparse and could use some color. But needs to lean on the Sphinx Docs. It could be copied to Sphinx Docs as an “intro” of sorts if needed.

We also need:

  • Longer explanations, examples, and demos for import.
  • Some general demos/examples for all submodules.
  • Consistent Power-Up docs.
  • Full docstrings in all submodules.
  • Links to repos in package READMEs.
@gormaniac gormaniac added the documentation Improvements or additions to documentation label Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gormaniac