Skip to content

docs: update public documentation #144

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

Merged
0xjunha merged 1 commit into from
May 13, 2026
Merged

docs: update public documentation #144

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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ All notable Darc release changes should be summarized here.

- Show GitHub Release titles as tags, such as `v0.1.6`, while preserving dated changelog headings.
- Narrow internal Rust storage APIs so SQLite schema details are no longer exposed outside the storage crate.
- Streamline public documentation around JSON query contracts and remove the internal backlog from docs.

## [0.1.5] - 2026-05-11

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,8 @@ Run `darc --help` or `darc help <command>` for the current CLI surface.
## Documentation

- [Documentation index](docs/README.md)
- [Query protocol](docs/query-protocol.md): command matrix, JSON schemas, pagination, search modes, performance
expectations, and error contracts.
- [Query protocol](docs/query-protocol.md): JSON envelopes, command contracts, search modes, payload semantics, and
error contracts.
- [Background refresh service](docs/service.md): macOS auto-refresh service behavior and watch settings.
- [Project rename and linking](docs/project-rename.md): keep history across checkout moves and repository renames.
- [Upgrade and uninstall](docs/upgrade-uninstall.md)
Expand Down
11 changes: 4 additions & 7 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@

Darc keeps the root README focused on overview and quickstart. Use these docs for workflow details and maintainer notes:

- [Query protocol](query-protocol.md)
Includes the canonical JSON read commands (`list`, `show`, `search`, `stats`, `resolve`, and `status --json`), the
`darc upgrade --check --json` payload contract, turn-scoped search, compact `--view oneline` skims, session bundles,
and best-effort model/token/runtime/patch-count fields on session and turn payloads.
- [Query protocol](query-protocol.md): JSON command contracts for agents and integrations.
- [Project rename and linking](project-rename.md)
- [Agent rollout schema audits](schema-audits.md)
- [Agent rollout schema changelog](schema-changelog.md)
- [Claude support](claude-support.md)
- [Background refresh service](service.md)
- [Upgrade and uninstall](upgrade-uninstall.md)
- [Release process](release.md)
- [Backlog](todo.md)
- [Agent rollout schema audits](schema-audits.md)
- [Agent rollout schema changelog](schema-changelog.md)
Loading
Loading