Skip to content

docs: make roadmaps the library landing pages - #145

Merged
Alexandre-T merged 1 commit into
mainfrom
131-story-make-roadmaps-the-library-landing-pages-and-link-documented-versions
Oct 26, 2026
Merged

Alexandre-T merged 1 commit into
mainfrom
131-story-make-roadmaps-the-library-landing-pages-and-link-documented-versions

Conversation

@Alexandre-T

@Alexandre-T Alexandre-T commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Pull Request

Summary

Make each library landing page its generated roadmap, replacing the previous overview body. Readers can open documented majors directly from the branch support table while historical documentation remains reachable.

Related issue

Closes #131. Contributes to Epic #125; dependencies #126 and #127 are integrated. Includes the already merged timeline simplifications from #132 through its main-branch base.

Changes

  • Documentation content added or updated
  • Docusaurus configuration or UI updated
  • Markdown generation updated
  • Documentation indexes or navigation updated
  • CI/CD or documentation tooling updated

Migrate all ten library roadmaps to docs/<library>/index.md, remove the separate roadmap pages, and preserve version landing pages. At build time, replace body nodes while retaining YAML front matter; repeated generation is idempotent.

Missing or blank JSON, {}, and valid configurations without branches display The roadmap for this library has not been established yet. They generate no SVG or support table. Malformed non-empty JSON and invalid configurations fail. Fully unannounced branch lists retain the configured-roadmap behavior.

Link branch labels to existing published major-version landing pages using portable Markdown or explicit HTML resources. Missing, draft and unlisted landing pages remain plain text. A short list preserves access to documented versions absent from the support schedule, including historical doctrine-spatial v4 and versions of libraries without an established roadmap.

Update navigation, source links, version-status messages and maintainer documentation. Packagist classification, roadmap dates, PHP compatibility and SVG presentation remain unchanged.

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; invokes npm run build with explicit local legal test configuration. Documentation corpus: 0 errors, 0 warnings.
  • A second full build with a temporarily empty spatial-transformer configuration passed; the original configuration was automatically restored and the final build uses the original data.
  • Repository Markdown lint: 103 files, 0 issues. git diff --check: passed.
  • Tests cover empty/missing/invalid configuration, unannounced dates, metadata preservation, repeated generation, branch links, missing destinations, navigation and version-status links in HTML/Markdown.
  • Firefox visual checks used locally served production HTML in light and dark themes at 1280px and 390px: populated doctrine-spatial and unestablished spatial-transformer. Mobile horizontal scrolling exposes the timeline and table columns.
  • composer test-local and composer quality: not applicable; neither is defined in this documentation repository.
  • GitHub Actions: documentation-check, apache-negotiation and Markdown Lint passed on 9dbbb1b.
  • Independent review: READY FOR MERGE on exact SHA 9dbbb1bd92487ff37a2375cf626a53a303c422c0.
  • Reviewer independently reproduced 446 passing tests/1 skipped, the development build under /spatial-docs/, clean corpus and lint. No blocking findings or Gates.

Documentation impact

Library index.html and index.md resources become the roadmap landing pages. Separate <library>/roadmap.html and <library>/roadmap.md resources are retired as requested by #131; internal links and status messages now target the indexes. Version documentation paths remain available. The roadmap generation and versioning guides describe the new target, fallback behavior and version links.

Checklist

  • The Pull Request has a clear and focused scope.
  • The related issue or Story acceptance criteria are satisfied.
  • 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 linked an issue Oct 26, 2026 that may be closed by this pull request
21 tasks

@Alexandre-T Alexandre-T left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

READY FOR MERGE

Independent review of 9dbbb1b against Story #131, AGENTS.md, the portable Markdown publication contract and the shared LongitudeOne pre-merge Definition of Done.

No blocking finding or unresolved governance gate remains.

Verified:

  • All ten library-level roadmap pages are replaced by library indexes. Version landing pages remain; their eight source edits only update the roadmap destination.
  • Shared build-time generation replaces body nodes and preserves YAML metadata. Repeated application/build export is idempotent.
  • Missing, blank, empty-object and valid no-branch configurations produce the exact fallback message without a timeline or support table. Invalid non-empty inputs fail; fully unannounced branches remain configured.
  • Published major landing pages receive branch links in both representations; absent or unpublished destinations remain plain text.
  • Historical documentation absent from the support schedule remains reachable through generated version links without inventing branch data.
  • Navigation, breadcrumbs/context and version-status messages use the new index resources. Generated HTML status and branch links also resolve correctly under the development /spatial-docs/ base.
  • Maintainer guidance covers the new target, fallback behavior and version destinations. Roadmap dates, PHP constraints and Packagist version classification are unchanged.

Independent checks:

  • npm test: 446 passed, 1 skipped, 0 failed.
  • DOCUSAURUS_DEPLOYMENT=development npm run build:local: passed, including the full build and corpus verification (0 errors, 0 warnings).
  • Markdown lint 0.23.3: 103 files, 0 issues.
  • git diff --check 2e876e2...HEAD: passed.
  • Additional isolated check with no configuration directory or display-window file: fallback generation, retained version navigation and source-file preservation passed.
  • Inspected generated HTML and Markdown, migration inventory and the version-index diffs.

CI is successful on this SHA: Markdown Lint, documentation-check (including repeated complete-build determinism and the development site), and apache-negotiation.

Visual pre-merge evidence was assessed from the Developer's actual Firefox checks of populated doctrine-spatial and unestablished spatial-transformer in light/dark themes at 1280px and 390px, including horizontal access to the rightmost table columns. I did not repeat the browser session; I independently rebuilt and inspected the generated resources.

No spatial normative behavior or public library API changes. The retirement of separate roadmap URLs is explicitly required by #131. Composer checks are not applicable to this Node.js documentation repository.

This is an independent agent verdict published as a GitHub review comment; it does not merge the PR or mark the Story Done. Merge remains Alexandre's decision.

@Alexandre-T
Alexandre-T merged commit 732bbd9 into main Oct 26, 2026
6 checks passed
@Alexandre-T
Alexandre-T deleted the 131-story-make-roadmaps-the-library-landing-pages-and-link-documented-versions branch October 26, 2026 16:40

This branch had an error being deployed

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

Story: Make roadmaps the library landing pages and link documented versions

1 participant