Skip to content

Commit e06e3fe

Browse files
committed
Refine docs sidebar navigation
1 parent 6475735 commit e06e3fe

4 files changed

Lines changed: 29 additions & 28 deletions

File tree

docs-site/agents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Use with agents"
2+
title: "Agent workflows"
33
description: "Give agents local files, clear rules, and a safe review path back to the source app."
44
---
55

docs-site/docs.json

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,40 +49,41 @@
4949
"navigation": {
5050
"groups": [
5151
{
52-
"group": "Start",
53-
"icon": "rocket",
52+
"group": "Get Started",
5453
"pages": [
5554
"overview",
5655
"install",
57-
"quickstart",
58-
"filesystem-model"
56+
"quickstart"
5957
]
6058
},
6159
{
62-
"group": "Use Locality",
63-
"icon": "folder-sync",
60+
"group": "Core Concepts",
61+
"pages": [
62+
"filesystem-model",
63+
"sync-safety"
64+
]
65+
},
66+
{
67+
"group": "Workflows",
6468
"pages": [
6569
"desktop",
6670
"agents",
6771
"best-practices",
68-
"sync-safety",
6972
"use-cases"
7073
]
7174
},
7275
{
73-
"group": "Reference",
74-
"icon": "terminal",
76+
"group": "Connectors",
7577
"pages": [
76-
"cli-reference",
7778
"connectors/notion",
78-
"connectors/google-docs",
79-
"okf-export"
79+
"connectors/google-docs"
8080
]
8181
},
8282
{
83-
"group": "Operations",
84-
"icon": "settings",
83+
"group": "Reference",
8584
"pages": [
85+
"cli-reference",
86+
"okf-export",
8687
"troubleshooting",
8788
"development"
8889
]

docs-site/llms.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,40 @@
22

33
> Locality mounts apps such as Notion and Google Docs as local Markdown files so humans, editors, and agents can read, edit, review, and sync work safely.
44

5-
## Read first
5+
## Get Started
66

77
- [Overview](overview.mdx): Product model, core surfaces, and safety model.
88
- [Install Locality](install.mdx): OS-specific GitHub release assets, verification, and updates.
99
- [Quickstart](quickstart.mdx): Install, connect, mount, edit, diff, and push.
10+
11+
## Core Concepts
12+
1013
- [Filesystem model](filesystem-model.mdx): How pages, databases, documents, stubs, media, and frontmatter map to files.
14+
- [Sync safety](sync-safety.mdx): Pending changes, remote drift, conflicts, restore, and diagnostics.
1115

12-
## Human workflows
16+
## Workflows
1317

1418
- [Desktop app](desktop.mdx): Onboarding, mounts, files, pending changes, and Live Mode.
19+
- [Agent workflows](agents.mdx): Agent contract, prompts, Live Mode behavior, and MCP fallback.
1520
- [Best practices](best-practices.mdx): Recommendations for reliable human and agent workflows.
1621
- [Use cases](use-cases.mdx): Engineering wiki updates, meeting notes, content operations, database workflows, OKF export, and safe agent handoff.
17-
- [Sync safety](sync-safety.mdx): Pending changes, remote drift, conflicts, restore, and diagnostics.
18-
19-
## Agent workflows
20-
21-
- [Use with agents](agents.mdx): Agent contract, prompts, Live Mode behavior, and MCP fallback.
2222

23-
Agent rule summary:
23+
## Agent Rule Summary
2424

2525
- edit mounted Markdown directly;
2626
- preserve Locality frontmatter, block identity directives, `_schema.yaml`, `AGENTS.md`, and `CLAUDE.md`;
2727
- use `loc status` and `loc diff` for inspection;
2828
- do not push unless the user explicitly asks or Live Mode has a safe path;
2929
- prefer scoped paths over broad workspace commands.
3030

31-
## Reference
31+
## Connectors
3232

33-
- [CLI reference](cli-reference.mdx): Essential `loc` command surface.
3433
- [Notion connector](connectors/notion.mdx): Notion projection, databases, supported writes, and common errors.
3534
- [Google Docs connector](connectors/google-docs.mdx): Google Docs projection, supported content, and limits.
36-
- [OKF export](okf-export.mdx): Export mounted content as portable Open Knowledge Format bundles.
3735

38-
## Operations
36+
## Reference
3937

38+
- [CLI reference](cli-reference.mdx): Essential `loc` command surface.
39+
- [OKF export](okf-export.mdx): Export mounted content as portable Open Knowledge Format bundles.
4040
- [Troubleshooting](troubleshooting.mdx): Provider drift, stale paths, connector errors, conflicts, Live Mode pauses, and build mismatches.
4141
- [Development](development.mdx): Repo setup, desktop dev, checks, daemon, File Provider, publish commands, and docs preview.

docs-site/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Locality"
2+
title: "Overview"
33
description: "Mount apps as local files so humans and agents can read, edit, review, and sync work safely."
44
---
55

0 commit comments

Comments
 (0)