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

Make admin user instructions a touch more obvious. #590

Merged
merged 4 commits into from
Feb 1, 2023

Conversation

Leopere
Copy link
Collaborator

@Leopere Leopere commented Feb 1, 2023

No description provided.

Running the README.md through some AI and Grammarly for clarity of intent and readability.  Review is likely required.
@Leopere
Copy link
Collaborator Author

Leopere commented Feb 1, 2023

I've added some clarification and highlights for steps that seemed less than self evident on my first attempt at installation.

The AI automatically inserted some numbered bullet points where otherwise there were none and the Grammarly software fixed a pile of the grammatical aberrations caused by myself, the AI, and previous documenters. This rewrite doesn't accommodate for any new use cases or anything interesting its purely just a clarity and readability cleanup.

@@ -2,111 +2,78 @@

[![Discord](https://img.shields.io/discord/559159668438728723.svg?logo=discord)](https://discord.gg/2TsNFKt)

**stash-box is Stash App's own OpenSource video indexing and Perceptual Hashing MetaData API server for porn.**
Stash-box is an open-source video indexing and metadata API server for porn developed by Stash App. The purpose of stash-box is to provide a community-driven database of porn metadata, similar to what MusicBrainz does for music. The submission and editing of metadata should follow the same principles as MusicBrainz. [Learn more here](https://musicbrainz.org/doc/Editing_FAQ). Installing Stash-box will create an empty database for you to populate.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the phrase perceptual hashing. I would say that it's worth mentioning as it's one of the core aspects.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The introduction aimed for something a bit more human digestible of you want to propose an additional PR that re-includes this I can merge it but I think a high level abstraction is a bit more digestible. Doesn't mean I want it gone but I think on this PR I'm going to leave it unless theres a suggestion.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator Author

@Leopere Leopere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Been reviewed by @DogmaDragon and adjustments made by @Leopere

@InfiniteStash InfiniteStash merged commit 82fd297 into master Feb 1, 2023
@InfiniteStash InfiniteStash deleted the Admin-user-Instructions branch February 1, 2023 20:32
Maista6969 pushed a commit to Maista6969/stash-box that referenced this pull request Jun 24, 2023
feederbox826 pushed a commit to feederbox826/stash-box that referenced this pull request Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants