Close #38: Moved information from README to documentation catalog.#40
Close #38: Moved information from README to documentation catalog.#40
Conversation
There was a problem hiding this comment.
Pull request overview
This PR moves documentation content from the README.md file into the DocC documentation catalog, addressing issue #38. The README is simplified to provide a brief overview and link to the full documentation, while detailed information about the library, CLI usage, installation, and platform support is moved to the appropriate documentation files.
Changes:
- Added Overview, Installation, and platform support sections to Documentation.md
- Added Authentication section with examples to CommandLineInterface.md
- Removed detailed documentation content from README.md, keeping only the essentials
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| Sources/Rainmaker/Documentation.docc/Documentation.md | Added Overview section with library description, platform support list, Installation section, and reorganized Topics section to move Command Line Interface to the top |
| Sources/Rainmaker/Documentation.docc/CommandLineInterface.md | Added Authentication section with examples showing both command-line options and environment variables usage |
| README.md | Removed detailed sections (Supported Platforms, CLI examples, Installation, Usage, Code Style header) and replaced with a reference to the documentation website |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
i2h3
force-pushed
the
38-readme-documentation
branch
from
a1ea155 to
075653a
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.