Retire the on-site documentation and align with docs.overture.bio v2 - #419
Merged
Conversation
…lat config Also fixes what lint found: missing rel on external links, conditional hooks in useActiveId, duplicate object keys.
118 pages, the MDX/YAML pipeline, 8 components and 27 dependencies removed; /documentation/* now 301s to docs.overture.bio. Do not deploy before overture-stack/docs#48 is live: the targets 404 until then.
Getting-started page now presents the four docs journeys; fixes broken product anchors (id was derived from viewport, rendered id=false); removes the Ego tile and the dead constants/products.js.
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs.overture.bio is now the only Overture documentation site, so this repo stops serving its own
/documentationsection and points at the docs site's v2 journeys instead.Important
this PR represents a base upgrade to the website to align it with the docsV2 update found here overture-stack/docs#48 once merged we will begin porting and updating this website into our docs repo/docusaurus site
Every docs link and redirect target here names a v2 route (
/develop,/deploy,/use,/community). Those routes 404 on docs.overture.bio until that PR ships. All 20 were verified against a production build of its branch.What changed
npm installpreviously failed on any supported Node (engines pinned Node 16, EOL since 2023);npm run lintcould not start (ESLint 5 config referenced three packages that were never installed). Now Node 22 + ESLint 9 flat config. Also fixed what lint found: missingrelon external links, conditional hooks, duplicate object keys./documentation/*now 301s to the docs site fromnetlify.toml. Build: 131 pages in 62s -> 14 pages in 12s. Advisories: 125 -> 87, criticals 8 -> 2.id="false"and every homepage tile scrolled nowhere); Ego tile and the now-unusedconstants/products.jsremoved.Review notes
npm ci,gatsby build,gatsby develop,npm run lint(15 errors / 68 warnings, a pre-existing baseline logged in.dev/tech-debt.md).NODE_VERSION = "22"(untested against a real build, andengine-strictnow fails the install rather than building on the wrong runtime), and that the/documentation/*redirects fire..dev/roadmap.mdand.dev/tech-debt.md, including the decision to port this site into the Docusaurus site next.