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

Documentation Overhaul #8584

Open
3 tasks
SchrodingersGat opened this issue Nov 28, 2024 · 4 comments
Open
3 tasks

Documentation Overhaul #8584

SchrodingersGat opened this issue Nov 28, 2024 · 4 comments
Labels
documentation enhancement This is an suggested enhancement or new feature
Milestone

Comments

@SchrodingersGat
Copy link
Member

Body of the issue

Overhaul documentation for 1.0.0 release

Tasks

  • Replace all screenshots with new interface
  • Ensure all new PUI features are documented
  • Add general "user interface" documentation (how to use tables, etc)
@SchrodingersGat SchrodingersGat added documentation triage:not-checked Item was not checked by the core team enhancement This is an suggested enhancement or new feature and removed triage:not-checked Item was not checked by the core team labels Nov 28, 2024
@SchrodingersGat SchrodingersGat added this to the 1.0.0 milestone Nov 28, 2024
@spyingcyclops
Copy link

Hi, I'd be interested in working on this

@SchrodingersGat
Copy link
Member Author

@spyingcyclops fantastic, the more help the better! There are a lot of features and aspects which are currently either undocumented or in need of improvement!

Please lmk if you need any help getting setup to build the documentation locally!

@matmair
Copy link
Member

matmair commented Nov 29, 2024

@SchrodingersGat should we take another shot at auto-generating screenshots? I seem to remember you had a pretty promising PR for that.

@SchrodingersGat
Copy link
Member Author

I can reopen that, but the amount of effort required to set it up seemed disproportionate. Compared to manually generating the screenshots

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement This is an suggested enhancement or new feature
Projects
None yet
Development

No branches or pull requests

3 participants