Fix Developer Documentation, update README #5
Conversation
This commit update the README and fixes the developer documentation links. Additionally, it adds links to the individual crates.io pages.
There was a problem hiding this comment.
Pull request overview
This pull request improves the developer documentation and README by fixing broken documentation links, adding informational badges, and reorganizing content for better clarity. The changes enhance the discoverability of the project's documentation and provide quick access to important repository information.
Changes:
- Fixed documentation links in dev-docs.md by updating relative paths from
./taco_*/index.htmlto./dev-docs/taco_*/index.html - Added informational badges to README.md (license, language, CI status, release version, discussions)
- Reorganized dev-docs.md to present Backend and Utility Crates before more specialized crates
- Added comprehensive crates summary tables to both README.md and dev-docs.md with badges linking to crates.io and documentation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/dev-docs.md | Fixed relative documentation links, reorganized crate sections, added GitHub badge and comprehensive crates summary table |
| README.md | Added repository badges at the top, restructured documentation section, added crates summary table, and improved contributing section |
| CHANGELOG.md | Added entry documenting the README and documentation link fixes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Paul Eichler <60977980+pleich@users.noreply.github.com>
1 participant
No description provided.