|
2 | 2 |
|
3 | 3 | > 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. |
4 | 4 |
|
5 | | -## Read first |
| 5 | +## Get Started |
6 | 6 |
|
7 | 7 | - [Overview](overview.mdx): Product model, core surfaces, and safety model. |
8 | 8 | - [Install Locality](install.mdx): OS-specific GitHub release assets, verification, and updates. |
9 | 9 | - [Quickstart](quickstart.mdx): Install, connect, mount, edit, diff, and push. |
| 10 | + |
| 11 | +## Core Concepts |
| 12 | + |
10 | 13 | - [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. |
11 | 15 |
|
12 | | -## Human workflows |
| 16 | +## Workflows |
13 | 17 |
|
14 | 18 | - [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. |
15 | 20 | - [Best practices](best-practices.mdx): Recommendations for reliable human and agent workflows. |
16 | 21 | - [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. |
22 | 22 |
|
23 | | -Agent rule summary: |
| 23 | +## Agent Rule Summary |
24 | 24 |
|
25 | 25 | - edit mounted Markdown directly; |
26 | 26 | - preserve Locality frontmatter, block identity directives, `_schema.yaml`, `AGENTS.md`, and `CLAUDE.md`; |
27 | 27 | - use `loc status` and `loc diff` for inspection; |
28 | 28 | - do not push unless the user explicitly asks or Live Mode has a safe path; |
29 | 29 | - prefer scoped paths over broad workspace commands. |
30 | 30 |
|
31 | | -## Reference |
| 31 | +## Connectors |
32 | 32 |
|
33 | | -- [CLI reference](cli-reference.mdx): Essential `loc` command surface. |
34 | 33 | - [Notion connector](connectors/notion.mdx): Notion projection, databases, supported writes, and common errors. |
35 | 34 | - [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. |
37 | 35 |
|
38 | | -## Operations |
| 36 | +## Reference |
39 | 37 |
|
| 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. |
40 | 40 | - [Troubleshooting](troubleshooting.mdx): Provider drift, stale paths, connector errors, conflicts, Live Mode pauses, and build mismatches. |
41 | 41 | - [Development](development.mdx): Repo setup, desktop dev, checks, daemon, File Provider, publish commands, and docs preview. |
0 commit comments