Skip to content

docs: fix ADR cross-links and clean up internal docstring references#9

Merged
adel-saoud merged 1 commit into
mainfrom
docs/cleanup-adr-links-and-docstrings
Jun 17, 2026
Merged

docs: fix ADR cross-links and clean up internal docstring references#9
adel-saoud merged 1 commit into
mainfrom
docs/cleanup-adr-links-and-docstrings

Conversation

@adel-saoud

Copy link
Copy Markdown
Owner

Summary

  • ADRs in context/decisions/ used a [[name]] link syntax that renders as literal text on GitHub. Converted to standard [ADR NNN](nnn-name.md) so the link graph works in the browser.
  • AGENTS.md companion-projects list pointed at local filesystem paths. Replaced with GitHub URLs.
  • A handful of docstrings carried stale internal references. Reworded to describe what the code does today.

No behavior changes.

Test plan

  • uv run ruff check . clean
  • uv run pyright 0 errors / 0 warnings
  • uv run pytest 130 passed, 93.31% coverage
  • CI green on the PR

- ADRs in context/decisions/ used a `[[name]]` link syntax that renders
  as literal text on GitHub. Converted to standard
  `[ADR NNN](nnn-name.md)` so the link graph works in the browser.
- AGENTS.md companion-projects list pointed at local filesystem paths.
  Replaced with GitHub URLs.
- A handful of docstrings carried stale internal references. Reworded
  to describe what the code does today.

No behavior changes.
@adel-saoud adel-saoud self-assigned this Jun 17, 2026
@adel-saoud
adel-saoud merged commit f358329 into main Jun 17, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant