Repository navigation
📖✨:lead readers to the SDK reference - #1913
Conversation
The SDK's API reference lived at /docs/sdk/, but nothing on the site led there: the Docs page only said it was not here yet, and the home page's SDK section had no link. A reader who did not already know the address would not find it. The top navigation gains an SDK entry, the Docs page gains a section for the reference in place of its "not here yet" note, naming the newest release once there is one, and the home page's install panel links the reference. Since the SDK's pages sit inside the docs, the Docs and SDK entries both match them. The header now marks only the last matching entry as the current page, so a reference page highlights SDK alone. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5
✅ Deploy Preview for gh-pages-openinf ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Essentials Run ID: 📒 Files selected for processing (6)
Included review availability: This review used your included allowance. 1 included review remains after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour. 📝 WalkthroughWalkthroughThe site adds an SDK menu entry and selects one matching menu link for active navigation. The Docs page now links to the SDK API reference and displays version-dependent text. The home page install note links to the reference. ChangesSDK Documentation
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Feature Merge Risk: ⚪ Minimal · up to The navigation selects the intended entry for Docs and SDK pages. No issue identified here prevents merging after normal checks. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Requested by DerekNonGeneric
Before: the SDK's API reference lived at
/docs/sdk/, but nothing on the site led there. The Docs page only said it was "not here yet", and the home page's SDK section had no link.After: the top navigation has an SDK entry. The Docs page has a "The SDK reference" section that names the newest release once one exists, and it replaces the "not here yet" note. The home page's install panel links the reference.
The header now marks only one entry as the current page. The SDK's pages sit inside the docs, so both Docs and SDK matched them, and the last match now wins.
How:
_data/menu.jsongains the entry with its ownsdk-sectionclass, becausesdkis already a section class on the home page. The SDK landing page and thesdk-apilayout carry that class, and_includes/header.liquidpicks the current link once before rendering either menu. The Docs page description avoids an apostrophe, which the meta tag does not escape and the HTML minifier then rejects.Companion to OpenINF/sdk#73, which points every npm package page and README at
/docs/sdk/. Built locally:/docs/sdk/highlights SDK alone, the handbook pages highlight Docs, and the home page highlights Home.verify.allpasses, except for the Dockerfile, TOML and EditorConfig checks. Those three fail the same way onlivein this sandbox, because they download tools it cannot reach.Summary by CodeRabbit
New Features
Bug Fixes