stashapp
[Documentation] Add definition of Organized button to Stash UI/Stash Docs
Users have brought up the fact that the "Organized" button is not mentioned anywhere in the UI Help or the Stash Docs. It has prompted some confusion about the purpose of the button. And what setting something as "Organized" affects specifically.
For reference, it seems in the code that the Organized button is meant to mark either scenes, images, or galleries as "Organized" aka completed. Like all information (or as much as can be) has been added and no more can. At least that is the impression I get as it is a simple boolean.
@WithoutPants has confirmed it affects Auto-Tag, Identify, and "possibly other mechanisms": https://github.com/stashapp/stash/pull/6303#issuecomment-3572695203
@DogmaDragon https://github.com/stashapp/Stash-Docs/blame/e424ad4f7a939a479d8001f30505e4520de0791b/docs/guides/scraping-scenes-via-stash-box.md#L50-L53
Is this satisfied or is more documentation needed
Organized flag has effect on automatic tasks (identify, auto tag) which prevents objects with the flag from being modified by these tasks and has secondary role of being a filterable parameter.
Identify is only available for scenes, while Auto Tag is available for scenes, images and galleries.
There are several ways to add Organized flag some of which are documented while others are not.
While as mentioned, the flag purpose in explained in one of our guides, it's not documented in the in-app manual.
- https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Identify.md
- https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/AutoTagging.md
This was on my to-do list for ages at this point. I keep kicking the can down the road since documenting the same thing in multiple places feels inefficient. The in-app manual needs a restructurization to better reflect current state of the project, but that is a major undertaking.
If someone wants to send a PR for this before I get to it I can review and approve it.
