Improve documentation #371
Merged
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
There was a problem hiding this comment.
Pull request overview
This PR restructures and improves the documentation by replacing the monolithic USAGE.md file with multiple focused guides covering specific topics. The new structure provides better organization and makes the documentation easier to navigate and reference.
Changes:
- Removed the single large
USAGE.mdfile - Created 10 new focused documentation files covering different aspects of fetch
- Updated README.md with links to the new documentation structure
- Made minor improvements to the existing
configuration.mdfile
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/USAGE.md | Deleted old monolithic usage guide |
| docs/getting-started.md | New installation and quickstart guide |
| docs/cli-reference.md | New complete CLI options reference |
| docs/request-bodies.md | New guide for sending various request body types |
| docs/output-formatting.md | New guide for response formatting options |
| docs/image-rendering.md | New guide for terminal image rendering |
| docs/authentication.md | New guide for authentication methods |
| docs/grpc.md | New guide for gRPC support |
| docs/advanced-features.md | New guide for advanced networking options |
| docs/troubleshooting.md | New troubleshooting and debugging guide |
| docs/configuration.md | Minor formatting improvements and additions |
| README.md | Updated with new documentation structure links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.