docs: add comprehensive dependencies reference#38
Conversation
- Add docs/dependencies.md with complete dependency catalog - Document all core and dev dependencies with purposes - Include version constraints and update policy - Add supply chain security information - Update docs/README.md index to reference new document - Update CHANGELOG.md with dependency update notes Closes documentation gap for external crate dependencies and their security/licensing implications. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…cc16 Resolve conflict in docs/README.md - keep newer date (2026-02-24).
There was a problem hiding this comment.
Pull request overview
Adds a new technical-reference document that catalogs ADRScope’s external dependencies (purpose, versions, and policies), and links it from the docs index while noting the addition in the changelog.
Changes:
- Added
docs/dependencies.mdwith a dependency catalog, MSRV/version policy, and supply-chain/security guidance. - Updated
docs/README.mdto include the new dependencies reference in the documentation index and quick reference table. - Updated
CHANGELOG.mdto record the new documentation and the pulldown-cmark patch update.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/dependencies.md | New dependency reference doc (catalog + policies + commands) |
| docs/README.md | Adds link to the new dependencies reference + quick task entry + date update |
| CHANGELOG.md | Notes dependency patch update and adds documentation entry |
| | 2026-02-24 | 0.3.0 | Updated pulldown-cmark 0.13.0 → 0.13.1 (patch release) | | ||
| | 2026-01-15 | 0.3.0 | Initial dependency reference documentation | |
There was a problem hiding this comment.
The changelog table claims an "Initial dependency reference documentation" entry on 2026-01-15, but this file is being introduced in this PR. Consider removing that row or updating it to reflect the actual introduction date/source to avoid confusing readers.
| | 2026-02-24 | 0.3.0 | Updated pulldown-cmark 0.13.0 → 0.13.1 (patch release) | | |
| | 2026-01-15 | 0.3.0 | Initial dependency reference documentation | | |
| | 2026-02-24 | 0.3.0 | Introduce dependency reference documentation | | |
| | 2026-02-24 | 0.3.0 | Updated pulldown-cmark 0.13.0 → 0.13.1 (patch release) | |
| cargo tree --depth 1 | ||
|
|
||
| # Include dev dependencies | ||
| cargo tree --depth 1 --all-features |
There was a problem hiding this comment.
cargo tree --all-features enables all feature flags but does not include dev-dependencies. If the intent is to show dev-deps too, update this command to use cargo-tree's dev edges (e.g., --edges dev / -e dev) or otherwise adjust the wording so it matches what the command actually prints.
| cargo tree --depth 1 --all-features | |
| cargo tree --depth 1 --all-features --edges dev |
| --- | ||
|
|
||
| **Last Updated**: 2026-02-18 | ||
| **Last Updated**: 2026-02-24 |
There was a problem hiding this comment.
This line no longer ends with a hard line break, so "Last Updated" and "Version" will render on the same line in CommonMark/GitHub Markdown. Add two trailing spaces at the end of the "Last Updated" line (as done in docs/dependencies.md) or insert a blank line so they render as separate lines.
| **Last Updated**: 2026-02-24 | |
| **Last Updated**: 2026-02-24 |
|
|
||
| ### Changed | ||
|
|
||
| - **[Deps]**: Update pulldown-cmark from 0.13.0 to 0.13.1 (patch release) |
There was a problem hiding this comment.
Changelog tag naming is inconsistent: this entry uses [Deps] while earlier entries use [Dependencies]. Please standardize the bracket tag to the existing convention to keep the changelog consistent.
| - **[Deps]**: Update pulldown-cmark from 0.13.0 to 0.13.1 (patch release) | |
| - **[Dependencies]**: Update pulldown-cmark from 0.13.0 to 0.13.1 (patch release) |
| | Crate | Version | Purpose | Features | | ||
| |-------|---------|---------|----------| | ||
| | **[clap](https://crates.io/crates/clap)** | 4.x | Command-line argument parsing | `derive` for proc-macro API | | ||
|
|
There was a problem hiding this comment.
The markdown tables here start with ||, which creates an unintended empty first column in GitHub-flavored Markdown. Use a single leading | for the header and separator rows (and apply the same fix to the other tables in this document).
Overview
Adds comprehensive documentation for all external dependencies used in ADRScope, addressing a documentation gap identified during routine documentation review.
Changes
New Documentation
docs/dependencies.md: Complete dependencies reference documentationUpdates
docs/README.md: Added dependencies reference to documentation indexCHANGELOG.md: Documented recent changesMotivation
This documentation addresses several needs:
Documentation Standards
Follows Diátaxis framework as technical reference documentation:
Testing
✅ Documentation-only change - no code modifications
✅ All markdown formatting verified
✅ Internal links validated
✅ Follows existing documentation style
Checklist
Type: Documentation
Impact: Low (documentation only)
Related: Recent pulldown-cmark 0.13.0 → 0.13.1 update (#33)