Skip to content

docs: track dependency upgrade progress and internal link guidance#781

Merged
simonrelet merged 2 commits intodevfrom
updates
Apr 14, 2026
Merged

docs: track dependency upgrade progress and internal link guidance#781
simonrelet merged 2 commits intodevfrom
updates

Conversation

@simonrelet
Copy link
Copy Markdown
Member

@simonrelet simonrelet commented Apr 14, 2026

Summary

  • Added a progress tracker to the dependency upgrade plan so upgrade execution status is visible at a glance.
  • Added internal links from each progress row to the corresponding phase section for quicker navigation.
  • Updated documentation-writing guidance to require co-located reference definitions for internal section links in long planning documents.

Context

  • This is documentation-only work for planning and process consistency; no runtime code paths were changed.
  • The tracking table enables incremental updates as each upgrade phase progresses.
  • Manual verification focused on link integrity and markdown readability in raw format.

Changes

Risks and mitigations

  • Risk: Internal heading anchor slugs can drift if headings are renamed.
    Mitigation: Reference definitions are now co-located with each target heading, so updates are localised and easier to maintain.
  • Risk: The progress tracker can become stale if not updated during upgrades.
    Mitigation: The plan includes an explicit instruction to update status as work starts and completes.

Checklist

  • Added in-code documentation (wherever needed). (N/A: docs-only changes)
  • Ran the linter to ensure style guidelines were followed. (Not run for this docs-only change)
  • Reviewed the changes for regressions.
  • Manually tested the changed behaviour.

Updates the documentation formatting rules to allow link references to be defined directly below target headings in long planning documents, rather than exclusively at the bottom of the file.
Relocates the dependency upgrade plan to the plans directory and introduces a progress table to monitor each phase. Internal link references have also been added below headings to improve navigation, following recently updated documentation guidelines.
@simonrelet simonrelet merged commit c7fa829 into dev Apr 14, 2026
1 check passed
@simonrelet simonrelet deleted the updates branch April 14, 2026 22:45
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