Skip to content

Commit aab68a1

Browse files
rsbhclaude
andauthored
fix: hide sidebar on landing page and update config docs (#47)
* fix: hide sidebar on landing page for paper theme Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: sync configuration.mdx with actual config schema Remove footer and llms sections that don't exist in schema. Add missing description, icon fields for content and api entries. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent a8048f4 commit aab68a1

2 files changed

Lines changed: 4 additions & 42 deletions

File tree

docs/content/docs/configuration.mdx

Lines changed: 3 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,6 @@ search:
8787
enabled: true
8888
placeholder: Search docs...
8989

90-
footer:
91-
copyright: "© 2026 My Company"
92-
links:
93-
- label: GitHub
94-
href: https://github.com/myorg/myproject
95-
9690
api:
9791
- name: REST API
9892
spec: ./openapi.yaml
@@ -105,9 +99,6 @@ api:
10599
header: Authorization
106100
placeholder: "Bearer token"
107101

108-
llms:
109-
enabled: true
110-
111102
analytics:
112103
enabled: true
113104
googleAnalytics:
@@ -160,6 +151,8 @@ content:
160151
|-------|------|-------------|
161152
| `dir` | `string` | Folder name under `content/`. Must be unique. |
162153
| `label` | `string` | Display label in navigation and landing pages. |
154+
| `description` | `string` | Optional description shown on landing page cards. |
155+
| `icon` | `string` | Optional icon identifier for landing page cards. |
163156

164157
### latest
165158

@@ -296,25 +289,6 @@ search:
296289

297290
When enabled, search is accessible via the navbar button or keyboard shortcut `Cmd+K` / `Ctrl+K`. Active version comes from the URL; switching versions scopes the index.
298291

299-
### footer
300-
301-
Footer content displayed at the bottom of every page.
302-
303-
```yaml
304-
footer:
305-
copyright: "© 2026 My Company. All rights reserved."
306-
links:
307-
- label: Terms
308-
href: /terms
309-
- label: Privacy
310-
href: /privacy
311-
```
312-
313-
| Field | Type | Description |
314-
|-------|------|-------------|
315-
| `copyright` | `string` | Copyright text (left-aligned) |
316-
| `links` | `NavLink[]` | Footer links (right-aligned) |
317-
318292
### api
319293

320294
OpenAPI specification configuration at the top level applies to the latest version (served at `/apis/...`). Version-scoped specs live under each `versions[].api`.
@@ -338,25 +312,13 @@ api:
338312
| `name` | `string` | API display name |
339313
| `spec` | `string` | Path to OpenAPI spec file (JSON or YAML), relative to `chronicle.yaml` |
340314
| `basePath` | `string` | URL path prefix for API pages (e.g., `/apis`) |
315+
| `icon` | `string` | Optional icon identifier |
341316
| `server.url` | `string` | Base URL for the API server |
342317
| `server.description` | `string` | Server description |
343318
| `auth.type` | `string` | Authentication type (e.g., `apiKey`, `bearer`) |
344319
| `auth.header` | `string` | Header name for auth token |
345320
| `auth.placeholder` | `string` | Placeholder text in auth input |
346321

347-
### llms
348-
349-
Per-version `llms.txt` generation.
350-
351-
```yaml
352-
llms:
353-
enabled: true
354-
```
355-
356-
| Field | Type | Description | Default |
357-
|-------|------|-------------|---------|
358-
| `enabled` | `boolean` | Emit `/llms.txt` and `/<version-dir>/llms.txt` | `false` |
359-
360322
### analytics
361323

362324
Analytics integration for tracking page views.

packages/chronicle/src/server/App.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export function App() {
4040
<ApiPage slug={apiSlug} />
4141
</ApiLayout>
4242
) : (
43-
<DocsLayout>
43+
<DocsLayout hideSidebar={isLanding}>
4444
{isLanding ? <LandingPage /> : <DocsPage slug={docsSlug} />}
4545
</DocsLayout>
4646
)}

0 commit comments

Comments
 (0)