Skip to content

docs: add comprehensive dependencies reference#38

Merged
zircote merged 2 commits intomainfrom
docs/add-dependencies-reference-97c76c2502fecc16
Mar 2, 2026
Merged

docs: add comprehensive dependencies reference#38
zircote merged 2 commits intomainfrom
docs/add-dependencies-reference-97c76c2502fecc16

Conversation

@github-actions
Copy link
Contributor

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 documentation
    • Core dependencies catalog (clap, serde, askama, pulldown-cmark, thiserror, time, glob)
    • Development dependencies (proptest, tempfile, pretty_assertions)
    • Version constraints and semantic versioning policy
    • Supply chain security information
    • Dependency graph visualization
    • Guidelines for adding new dependencies

Updates

  • docs/README.md: Added dependencies reference to documentation index

    • New entry in Technical Reference section
    • Quick reference table entry for dependency checking
    • Updated last modified date to 2026-02-24
  • CHANGELOG.md: Documented recent changes

    • pulldown-cmark 0.13.0 → 0.13.1 update
    • New dependencies documentation

Motivation

This documentation addresses several needs:

  1. Transparency: Contributors and users can understand the tech stack at a glance
  2. Security: Clear documentation of supply chain security practices
  3. Maintainability: Version constraints and update policies are explicit
  4. Evaluation: Users evaluating ADRScope can assess dependencies upfront

Documentation Standards

Follows Diátaxis framework as technical reference documentation:

  • Information-oriented (precise descriptions)
  • Structured by dependency category
  • Cross-referenced with ADRs
  • Includes practical examples

Testing

✅ Documentation-only change - no code modifications
✅ All markdown formatting verified
✅ Internal links validated
✅ Follows existing documentation style

Checklist

  • New documentation file created
  • Documentation index updated
  • Changelog updated
  • Last updated dates refreshed
  • Cross-references to ADRs included
  • Examples and commands provided

Type: Documentation
Impact: Low (documentation only)
Related: Recent pulldown-cmark 0.13.0 → 0.13.1 update (#33)

AI generated by Update Docs

- 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).
@zircote zircote marked this pull request as ready for review March 2, 2026 04:09
Copilot AI review requested due to automatic review settings March 2, 2026 04:09
@zircote zircote merged commit 15b8b26 into main Mar 2, 2026
11 checks passed
@zircote zircote deleted the docs/add-dependencies-reference-97c76c2502fecc16 branch March 2, 2026 04:09
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with a dependency catalog, MSRV/version policy, and supply-chain/security guidance.
  • Updated docs/README.md to include the new dependencies reference in the documentation index and quick reference table.
  • Updated CHANGELOG.md to 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

Comment on lines +242 to +243
| 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 |
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
| 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) |

Copilot uses AI. Check for mistakes.
cargo tree --depth 1

# Include dev dependencies
cargo tree --depth 1 --all-features
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
cargo tree --depth 1 --all-features
cargo tree --depth 1 --all-features --edges dev

Copilot uses AI. Check for mistakes.
---

**Last Updated**: 2026-02-18
**Last Updated**: 2026-02-24
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
**Last Updated**: 2026-02-24
**Last Updated**: 2026-02-24

Copilot uses AI. Check for mistakes.

### Changed

- **[Deps]**: Update pulldown-cmark from 0.13.0 to 0.13.1 (patch release)
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- **[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)

Copilot uses AI. Check for mistakes.
Comment on lines +17 to +20
| Crate | Version | Purpose | Features |
|-------|---------|---------|----------|
| **[clap](https://crates.io/crates/clap)** | 4.x | Command-line argument parsing | `derive` for proc-macro API |

Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants