docs: Reorganize README into focused documentation #23
Conversation
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
Owner
Author
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Streamlines the README by moving detailed content into separate docs files, making the main README more concise and easier to scan.
Changes
README now includes:
New docs files:
docs/alternative-installations.md- Go install, binary download, build from sourcedocs/commands.md- Full command reference with all flagsdocs/configuration.md- Configuration optionsdocs/examples.md- Workflow examplesdocs/how-it-works.md- Stack tracking and sync algorithmdocs/troubleshooting.md- Common issues and solutionsREADME reduced from ~290 lines to ~100 lines while maintaining discoverability through links.