InvenTree icon indicating copy to clipboard operation
InvenTree copied to clipboard

Documentation Overhaul

Open SchrodingersGat opened this issue 1 year ago • 7 comments

Body of the issue

Overhaul documentation for 1.0.0 release

Tasks

  • [x] Replace all screenshots with new interface
  • [x] Ensure all new PUI features are documented
  • [ ] Add general "user interface" documentation (how to use tables, etc)
  • [ ] Add documentation on user "theme" settings
  • [ ] Look again at "automating" screenshots (so they don't get out of date)
  • [ ] Provide screenshots in light / dark themes?

SchrodingersGat avatar Nov 28 '24 21:11 SchrodingersGat

Hi, I'd be interested in working on this

spyingcyclops avatar Nov 29 '24 07:11 spyingcyclops

@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!

SchrodingersGat avatar Nov 29 '24 07:11 SchrodingersGat

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

matmair avatar Nov 29 '24 07:11 matmair

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

SchrodingersGat avatar Nov 29 '24 07:11 SchrodingersGat

@spyingcyclops are you working on this / do you need assistance?

matmair avatar Jan 28 '25 23:01 matmair

No, no capacity to work on it atm, thanks

On Wed, Jan 29, 2025, 00:42 Matthias Mair @.***> wrote:

@spyingcyclops https://github.com/spyingcyclops are you working on this / do you need assistance?

— Reply to this email directly, view it on GitHub https://github.com/inventree/InvenTree/issues/8584#issuecomment-2620278572, or unsubscribe https://github.com/notifications/unsubscribe-auth/AVM6C6XBM7AYMXDVQ4Q4J7T2NAIVNAVCNFSM6AAAAABSV5GUMWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMRQGI3TQNJXGI . You are receiving this because you were mentioned.Message ID: @.***>

spyingcyclops avatar Jan 29 '25 10:01 spyingcyclops

no worries, thanks for the prompt response.

matmair avatar Jan 29 '25 21:01 matmair