Skip to content

docs: list all documented versions on library landing pages - #146

Merged
Alexandre-T merged 1 commit into
mainfrom
fix/roadmap
Oct 26, 2026
Merged

Alexandre-T merged 1 commit into
mainfrom
fix/roadmap

Conversation

@Alexandre-T

Copy link
Copy Markdown
Contributor

Pull Request

Summary

The Documentation versions section previously listed only versions absent from the roadmap table, so doctrine-spatial showed only v4 there. Display every published version landing page in this section, including versions already linked in the support table.

For doctrine-spatial, the list now includes v4, v5, v6 and v7.

Related issue

Follow-up to #131, requested by the maintainer.

Changes

  • Documentation content added or updated
  • Markdown generation updated
  • Documentation indexes or navigation updated

The shared generator emits the full version list in both HTML and portable Markdown. The same navigation remains available when no roadmap is established; libraries without documented versions do not receive an empty list.

Standards and references

  • Not applicable

References: No normative spatial behavior is affected.

Source and generated content

  • Source Markdown is valid and linted.
  • Generated Markdown resources are up to date.
  • Generated content is consistent with its source.
  • Docusaurus builds successfully.
  • Internal links are valid.
  • Navigation and indexes are consistent.

Validation

  • Markdown lint passes.
  • Documentation build passes.
  • Generated resources have been checked.
  • Relevant links have been checked.
  • The rendered documentation has been visually reviewed.
  • CI passes.

Additional validation:

  • npm test: 446 passed, 1 skipped, 0 failed.
  • npm run build:local: passed; documentation corpus has 0 errors and 0 warnings.
  • Markdown lint for the updated maintainer guide: passed.
  • git diff --check: passed.
  • Regression coverage verifies the full list and link destinations in both representations, with and without a configured roadmap, plus the absence of empty lists.
  • Inspected generated doctrine-spatial HTML and Markdown: all four version links are present with their explicit resource paths.
  • Visual verification of the updated browser page remains unconfirmed. CI has not yet been verified.

Documentation impact

Every library landing page lists all published documentation versions under Documentation versions. The maintainer guide describes this behavior. Existing URLs and branch links in the support table remain unchanged.

Checklist

  • The Pull Request has a clear and focused scope.
  • Documentation terminology is consistent with the referenced standards.
  • No generated file was manually edited when it must be generated from a source.
  • No unrelated change is included.
  • Documentation impact was assessed; affected public behavior is documented, or the reason no update is needed is stated.
  • The Pull Request is ready for review.

@Alexandre-T
Alexandre-T merged commit b124704 into main Oct 26, 2026
4 checks passed
@Alexandre-T
Alexandre-T deleted the fix/roadmap branch October 26, 2026 18:18

This branch had an error being deployed

1 failed deployment
github-pages — f07ccc72 Deployed Oct 26, 2026 by Alexandre-T via build #41
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