docs: improve README structure and add comprehensive CLI documentation #493
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
- Restructure main README with clearer feature descriptions and better navigation - Add detailed examples and usage patterns to CLI tool documentation (dds-session, dds-info, dds-topology, etc.) - Create comprehensive user defaults configuration reference with all available options - Update tutorials with better automation examples and clearer instructions - Improve documentation formatting and add more practical examples throughout - Update links to point to GitHub releases instead of legacy download pages - Fix minor typos and improve consistency across documentation files This update makes the documentation more user-friendly and provides better guidance for both new users and advanced configurations.
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.
This update makes the documentation more user-friendly and provides better
guidance for both new users and advanced configurations.