Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions _data/menu.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
"permalink": "docs",
"class": "docs"
},
{
"text": "SDK",
"permalink": "docs/sdk/",
"class": "sdk-section"
},
{
"text": "About",
"permalink": "about",
Expand Down
18 changes: 14 additions & 4 deletions _includes/header.liquid
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
{%- comment -%}
One link is current. The SDK's pages sit inside the docs, so both entries
match them; the menu lists SDK after Docs, and the last match wins.
{%- endcomment -%}
{%- assign current_link = '' -%}
{%- for link in menu -%}
{%- if body_classes contains link.class -%}
{%- assign current_link = link.class -%}
{%- endif -%}
{%- endfor -%}
<header class='site-header'>
<nav
class='navbar navbar-expand-md navbar-dark fixed-top bg-dark'
Expand All @@ -24,9 +34,9 @@
{% for link in menu %}
<li class='nav-item'>
<a
class='nav-link{% if body_classes contains link.class %} active{% endif %}'
class='nav-link{% if link.class == current_link %} active{% endif %}'
href='/{{ link.permalink }}'
{% if body_classes contains link.class %}
{% if link.class == current_link %}
aria-current='page'
{% endif %}
>
Expand All @@ -51,9 +61,9 @@
{% for link in menu %}
<li class='nav-item'>
<a
class='nav-link{% if body_classes contains link.class %} active{% endif %}'
class='nav-link{% if link.class == current_link %} active{% endif %}'
href='/{{ link.permalink }}'
{% if body_classes contains link.class %}
{% if link.class == current_link %}
aria-current='page'
{% endif %}
>
Expand Down
1 change: 1 addition & 0 deletions _layouts/sdk-api.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ body_classes:
- docs
- doc-page
- sdk-api
- sdk-section
editable: false
---
{%- assign release = sdkApi.versions | where: 'version', api_version | first -%}
Expand Down
40 changes: 30 additions & 10 deletions collections/_pages/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
layout: default
permalink: /docs/
description:
How to take part in OpenINF, and the house style the work is written in.
How to take part in OpenINF, the house style the work is written in, and the
API reference for the SDK.
body_classes:
- docs
- docs-index
Expand Down Expand Up @@ -33,8 +34,8 @@
<div class="docs-head-lead">
<h1 class="docs-title">Docs</h1>
<p class="docs-lede">
Two kinds of writing live here: how to take part in the work, and how
the work gets written down.
Three kinds of writing live here: how to take part in the work, how
the work gets written down, and the SDK's API reference.
</p>
</div>

Expand Down Expand Up @@ -115,14 +116,33 @@ <h2 class="section-title" id="handbook-title">The style handbook</h2>
</div>
</section>

<!-- ================= what is not here yet =========================== -->
<section class="band band-tail">
<!-- ================= the SDK reference ============================== -->
<section class="band" id="sdk" aria-labelledby="sdk-ref-title">
<div class="wrap">
<h2 class="tail-title" id="soon-title">Not here yet</h2>
<p class="tail-what">
The OpenINF SDK arrives in Q4 2026, and its reference documentation
arrives with it.
<a href="/news/">Progress shows up in the news</a>.
<div class="section-head">
<h2 class="section-title" id="sdk-ref-title">The SDK reference</h2>
</div>

{%- if sdkApi and sdkApi.versions.size > 0 %}
{%- assign newest = sdkApi.versions | first %}
<p class="handbook-lede">
The API reference for every OpenINF SDK package, generated from the
source and kept for each release. The newest is
{{ newest.version }}.
</p>
{%- else %}
<p class="handbook-lede">
The API reference for every OpenINF SDK package, generated from the
source. It appears with the first release;
<a href="/news/">progress shows up in the news</a>.
</p>
{%- endif %}

<p class="handbook-more">
<a class="handbook-link" href="/docs/sdk/">
Browse the SDK reference
<span class="handbook-link-arrow" aria-hidden="true">&rarr;</span>
</a>
</p>
</div>
</section>
Expand Down
3 changes: 3 additions & 0 deletions collections/_pages/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ <h3 class="area-name">Terminal-friendly text</h3>
<code>@openinf</code> scope, in TypeScript with type declarations
from the start.
</p>
<p class="install-note">
<a href="/docs/sdk/">Read the API reference</a> for every package.
</p>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion collections/_pages/sdk.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
layout: deep-page.liquid
permalink: /docs/sdk/
description: API reference and package guides for the OpenINF SDK.
body_classes: docs doc-page sdk-overview
body_classes: docs doc-page sdk-overview sdk-section
editable: false
---
The OpenINF SDK is the shared foundation for building dependable integrations
Expand Down
Loading