Skip to content

docs: clarify TypeDoc coverage after Lit adapter #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SutuSebastian wants to merge 1 commit into from
Closed

docs: clarify TypeDoc coverage after Lit adapter #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions apps/docs/content/reference/api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: API
description: Exhaustive CI-generated TypeDoc reference — every export across core and the adapters.
description: Exhaustive CI-generated TypeDoc for core and the React/Preact/Solid/Angular/Vue/Svelte entries — Lit is on its adapter page.
sidebar:
label: Overview
search:
Expand All @@ -10,7 +10,7 @@ search:
import Card from "blume/components/content/Card.astro";
import CardGroup from "blume/components/content/CardGroup.astro";

One TypeDoc module per package. [Reference](/reference) · [Core API](/reference/core-api) · [Adapter hooks](/reference/adapter-hooks)
One TypeDoc module per entry in `typedoc.json`. Lit is documented on its [adapter page](/adapters/lit) (not generated here yet). [Reference](/reference) · [Core API](/reference/core-api) · [Adapter hooks](/reference/adapter-hooks)

<CardGroup cols={3}>
<Card title="Core" href="/reference/api/core" icon="/icons/vanilla.svg" arrow>
Expand All @@ -31,6 +31,9 @@ One TypeDoc module per package. [Reference](/reference) · [Core API](/reference
<Card title="Vue" href="/reference/api/vue" icon="/icons/vue.svg" arrow>
`@stainless-code/vue-layers`
</Card>
<Card title="Lit" href="/adapters/lit" icon="/icons/lit.svg" arrow>
`@stainless-code/lit-layers` (adapter page)
</Card>
<Card title="Svelte (runes)" href="/reference/api/svelte" icon="/icons/svelte.svg" arrow>
`@stainless-code/svelte-layers`
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The symbols and hook signatures you reach for most often — with minimal exampl
| [Adapter hooks](/reference/adapter-hooks) | Hook and provider matrix across React, Preact, Solid, Angular, Vue, Lit, and Svelte |
| [Roadmap](/reference/roadmap) | Forward-looking work — not a mirror of shipped `src/` |
| [Migration](/reference/migration) | Breaking-change policy and migration notes when they ship |
| [API reference](/reference/api) | Exhaustive CI-generated TypeDoc reference — every export across `core` and the adapters, regenerated on every docs build |
| [API reference](/reference/api) | Exhaustive CI-generated TypeDoc for `core` and the React/Preact/Solid/Angular/Vue/Svelte entries (Lit: [adapter page](/adapters/lit)); regenerated on every docs build |

## Release history

Expand Down
Loading