Repository navigation
Expand file tree
/
Copy pathsidebar.ts
More file actions
95 lines (92 loc) · 3.56 KB
/
Copy pathsidebar.ts
File metadata and controls
95 lines (92 loc) · 3.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
import type { StarlightUserConfig } from "@astrojs/starlight/types";
// Single source of truth for both Starlight's sidebar rendering and the
// page order in the LLM-friendly outputs (llms.txt and friends), via
// the starlight-llm-tools plugin which reads this from the Starlight
// config at build time.
export const sidebar: StarlightUserConfig["sidebar"] = [
{ label: "Home", link: "/" },
{ label: "Getting Started", slug: "getting-started" },
{ label: "Why WaveHouse?", slug: "why-wavehouse" },
{
label: "Guides",
items: [
{ label: "Architecture", slug: "architecture" },
{ label: "Ingest Pipeline", slug: "ingest-pipeline" },
{ label: "Access Control", slug: "access-control" },
{ label: "Named Pipes", slug: "pipes" },
],
},
{
// Lookup material, not narrative — its own group so "I need the exact
// endpoint/method" readers don't scan the conceptual guides for it.
label: "Reference",
items: [
{ label: "API Reference", slug: "api" },
{
// Topic-first SDK pages: when a second SDK language lands, these
// shared usage pages grow <Tabs syncKey="lang"> code tabs and each
// language gets its own setup/caveats page — the topic URLs never
// churn (decision in PR #313).
label: "TypeScript SDK",
items: [
{ label: "Overview", slug: "sdk" },
{ label: "Queries", slug: "sdk/queries" },
{ label: "Streaming & Live Queries", slug: "sdk/streaming" },
{ label: "Pipes", slug: "sdk/pipes" },
{ label: "Admin & System", slug: "sdk/admin" },
{ label: "Reference & CLI", slug: "sdk/reference" },
],
},
],
},
{
label: "Operations",
items: [
{ label: "Configuration", slug: "configuration" },
{ label: "Deployment", slug: "deployment" },
{ label: "Durability & Storage", slug: "durability" },
{ label: "Behind a reverse proxy", slug: "reverse-proxy" },
],
},
{
label: "Contributing",
items: [
{ label: "Development", slug: "development" },
{ label: "Claude Code & AI agents", slug: "claude-code" },
{
label: "Contributing Guide",
link: "https://github.com/Wave-RF/WaveHouse/blob/main/CONTRIBUTING.md",
attrs: { target: "_blank", rel: "noopener" },
},
{
label: "Discussions",
link: "https://github.com/Wave-RF/WaveHouse/discussions",
attrs: { target: "_blank", rel: "noopener" },
},
{
label: "Support",
link: "https://github.com/Wave-RF/WaveHouse/blob/main/SUPPORT.md",
attrs: { target: "_blank", rel: "noopener" },
},
{
label: "Security Policy",
link: "https://github.com/Wave-RF/WaveHouse/blob/main/SECURITY.md",
attrs: { target: "_blank", rel: "noopener" },
},
{
label: "Changelog",
link: "https://github.com/Wave-RF/WaveHouse/blob/main/CHANGELOG.md",
attrs: { target: "_blank", rel: "noopener" },
},
],
},
];
// Top-level link(s) for the site header (src/components/Header.astro), colocated
// with the sidebar so header and sidebar share one file as the single source of
// truth for navigation. A single "Docs" entry into the doc tree: the splash
// homepage hides the sidebar, so this is the way in from there; every doc page
// already carries the full sidebar. Root-absolute href matches the internal link
// convention used across the docs (index.mdx hero, LinkCards).
export const headerNav: { label: string; href: string }[] = [
{ label: "Docs", href: "/getting-started" },
];