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

Clean up documentation contents #67

Closed
2 tasks
NoraLoose opened this issue Sep 4, 2024 · 0 comments
Closed
2 tasks

Clean up documentation contents #67

NoraLoose opened this issue Sep 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@NoraLoose
Copy link
Contributor

It would be nice to

  • break up the notebook cstar_example_notebook.ipynb in docs/ into several shorter and self-consistent notebooks to make the contents more digestible for the user
  • move stuff out of the README into the documentation to avoid duplicate contents (which is hard to maintain)
@NoraLoose NoraLoose added the documentation Improvements or additions to documentation label Sep 4, 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
@NoraLoose