chore: streamline project documentation - #10
Merged
Conversation
The README and agent guide repeated implementation detail, making setup and the repository's important operating constraints harder to find. The README also described older Python and Docker Compose usage. Reorganize both documents around concise quick-reference sections. Keep the database, crawler, private-list, configuration, merge, and release safeguards while shortening feature and implementation descriptions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README and agent guide repeated implementation detail, which made setup and
the repository's important operating constraints harder to find. The README
also described older Python and Docker Compose usage.
What
Reorganize both documents around concise quick-reference sections. The README
now leads with a secure Compose quick start and focused configuration guidance,
while the agent guide keeps the database, crawler, private-list, merge, and
release safeguards in a shorter structure.