Skip to content

📖✨:lead readers to the SDK reference - #1913

Merged
openinf-commit-queue[bot] merged 1 commit into
livefrom
claude/project-thread-2cmykj
Sep 30, 2026
Merged

openinf-commit-queue[bot] merged 1 commit into
livefrom
claude/project-thread-2cmykj

Conversation

@DerekNonGeneric

@DerekNonGeneric DerekNonGeneric commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

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.json gains the entry with its own sdk-section class, because sdk is already a section class on the home page. The SDK landing page and the sdk-api layout carry that class, and _includes/header.liquid picks 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.all passes, except for the Dockerfile, TOML and EditorConfig checks. Those three fail the same way on live in this sandbox, because they download tools it cannot reach.

Summary by CodeRabbit

  • New Features

    • Added an SDK entry to the main navigation and a dedicated API reference section on the Docs page.
    • The reference displays the newest available version, or links to news when no versions are available.
    • Updated the SDK installation note to direct readers to the API reference.
  • Bug Fixes

    • Navigation now marks only the matching section as current, keeping the main navigation and sidebar in sync.

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
@DerekNonGeneric DerekNonGeneric self-assigned this Sep 29, 2026
@netlify

netlify Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for gh-pages-openinf ready!

Name Link
🔨 Latest commit 484e120
🔍 Latest deploy log https://app.netlify.com/projects/gh-pages-openinf/deploys/6abb11fdfd5297000894dc5a
😎 Deploy Preview https://deploy-preview-1913--gh-pages-openinf.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 35608c3e-34e0-448b-beb5-88afec3b4992

📥 Commits

Reviewing files that changed from the base of the PR and between c6d5d8e and 484e120.

📒 Files selected for processing (6)
  • _data/menu.json
  • _includes/header.liquid
  • _layouts/sdk-api.liquid
  • collections/_pages/docs.html
  • collections/_pages/home.html
  • collections/_pages/sdk.html

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.


📝 Walkthrough

Walkthrough

The 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.

Changes

SDK Documentation

Layer / File(s) Summary
SDK menu and active navigation
_data/menu.json, _includes/header.liquid, _layouts/sdk-api.liquid, collections/_pages/sdk.html
The menu adds an SDK entry. The SDK pages use the sdk-section class. The header selects one matching link for active styling and aria-current.
SDK reference page content
collections/_pages/docs.html, collections/_pages/home.html
The Docs page describes and links to the SDK API reference. It shows the newest version when available, or a first-release notice otherwise. The home page install note links to the reference.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 484e1

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)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: directing readers to the SDK reference through navigation and documentation links. It is concise and specific, although it includes decorative emojis.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@DerekNonGeneric DerekNonGeneric added the 🚀 Status: Commit Queue Land this pull request when its checks pass label Sep 30, 2026 — with Claude
@openinf-commit-queue
openinf-commit-queue Bot merged commit 769382b into live Sep 30, 2026
19 checks passed
@openinf-commit-queue openinf-commit-queue Bot removed the 🚀 Status: Commit Queue Land this pull request when its checks pass label Sep 30, 2026
@openinf-commit-queue
openinf-commit-queue Bot deleted the claude/project-thread-2cmykj branch September 30, 2026 22:47
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