AB#1388992 — Replace 404ing Orion documentation links on WebCoreStyleSheets feature pages #295
jason-capsule42
started this conversation in
Post Mortems
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
AB#1388992
Executive Summary
The WebCoreStyleSheets feature documentation pages linked out to the old Orion design system website for their "see the documentation" references. That site was retired when the team completed its move from Orion to Auro, so every one of those links returned a "page not found" error. This change repoints all of those references to the current, live WebCoreStyleSheets documentation site, so readers can once again follow them and land on the correct reference material.
Tracked in AB#1388992.
The Problem
The public feature documentation at
auro.alaskaair.com/webcorestylesheets/featuresis generated from the repository'sFEATURES.md. Under most feature headings, that page offered a convenience link — "see the API", "see the spec", "prefixing and scoping API" — meant to take the reader to the detailed reference for that feature.Those links still pointed at the previous-generation Orion site (
alaskaairlines.github.io/OrionWebCoreStyleSheets/...). Because that site has been decommissioned, following any of them produced a dead end. Broken links on the documentation site erode trust and block developers from finding the guidance they need to use the framework correctly.Root Cause
The links were hard-coded in
FEATURES.mdand were never updated when the documentation site moved from Orion to the current WebCoreStyleSheets SassDoc site (alaskaairlines.github.io/WebCoreStyleSheets/, built byscripts/sassdoc.build.mjs). Five references still carried the retiredOrionWebCoreStyleSheetshost:#scope-prefix!importantspec →#utility-variable-importantlayoutPropertiesGeneratorAPI →#utility-layout-mixin-auro_layoutPropertiesGeneratorinsetUtilityAPI →#utility-layout-mixin-auro_insetspacingUtilityAPI →#utility-layout-mixin-auro_spacingA compounding factor for one link: the inset utility was demoted from a SassDoc mixin to a statically generated set of classes (
src/utilityClasses/_inset.scss, now flagged viadeprecated.deprecated(...)). As a result its SassDoc anchor changed from#utility-layout-mixin-auro_insetto the group anchor#utility-inset, so a naive host-only swap would still have 404'd on the fragment.The Fix
All five links in
FEATURES.mdwere repointed to the current documentation site, and upgraded fromhttp://tohttps://:#scope-prefix,#utility-variable-important,#utility-layout-mixin-auro_layoutPropertiesGenerator,#utility-layout-mixin-auro_spacing) kept their fragments and only had the host changed fromalaskaairlines.github.io/OrionWebCoreStyleSheets/toalaskaairlines.github.io/WebCoreStyleSheets/.https://alaskaairlines.github.io/WebCoreStyleSheets/#utility-inset.No other documentation files needed changes:
README.mdandMIGRATION.mdalready point at the live site root, andFAQ.md's deep link (#utility-layout-mixin-auro_layoutPropertiesGenerator) was already on the current host and remains valid.Why This Works
The current documentation site is generated by SassDoc from
./srcinto./docsand published atalaskaairlines.github.io/WebCoreStyleSheets/. SassDoc uses a deterministic anchor scheme (<group>-<type>-<name>) that the Orion site also used, so four of the five fragments carry over unchanged — only the host was ever wrong for those.Each destination anchor was verified to exist in the built
docs/index.htmlbefore shipping:#scope-prefix✓#utility-variable-important✓#utility-layout-mixin-auro_layoutPropertiesGenerator✓#utility-inset✓ (the old#utility-layout-mixin-auro_insetno longer exists, confirming the remap was necessary)#utility-layout-mixin-auro_spacing✓Because
docs/index.htmlis the exact artifact that is published, an anchor present there is present on the live site — the links resolve to real, current reference material rather than a retired host.Outcome
Every feature-heading documentation link on the WebCoreStyleSheets features page now points to live, working reference material instead of a decommissioned site. Readers following "see the API / spec / prefixing and scoping API" from the features page reach the intended content, restoring the documentation's reliability and reflecting the completed migration off Orion.
Ticket Completeness
Both requirements expressed in the ticket are resolved. (The ticket had no formal Description or Acceptance Criteria fields; requirements were taken from its repro-steps "Current/Desired behavior".)
Resolved
FEATURES.md(the source of the features page) were replaced; a repo-wide check confirms noOrionWebCoreStyleSheetsreferences remain in the docs.alaskaairlines.github.io/WebCoreStyleSheets/, and every destination anchor was verified present in the builtdocs/index.html, including the remapped#utility-inset.Learnings
#utility-layout-mixin-auro_inset→#utility-inset), which can break deep links even after the host is corrected.docs/index.html, not just the host — a link that returns 200 at the host can still land nowhere if the fragment is stale.*.mdfor retired hosts (OrionWebCoreStyleSheets) and for anchors that don't exist in the built docs would catch this class of regression automatically.All reactions