Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
283 changes: 93 additions & 190 deletions README.md

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions docs/PROJECT_PROVENANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Project provenance

CapstanAI LabNote is human-led. Human maintainers retain authorship, decision
authority, repository control, and release authority.

The project has also used managed AI assistance for development, implementation,
testing, review, localisation, and documentation. The roles below describe that
assistance transparently; they do not transfer responsibility away from the
human maintainers.

## Managed AI contributions

| Contributor | Role in the project |
| --- | --- |
| ChatGPT (“Cal”) | Project design, documentation development, implementation coordination, and review |
| Claude | Independent critique, testing, and editorial review |
| OpenAI Codex | Repository implementation, validation design, and technical review |
| Claude Code | Implementation and test assistance |
| DeepSeek | Simplified-Chinese translation assistance and linguistic, cultural, and adversarial review |

## What this record means

This is a project-wide provenance record. It describes the kinds of assistance
used while the project was developed and reviewed.

It is not an employment record, an agency relationship, an authorship transfer,
or a claim that an AI system holds responsibility for a project decision,
repository change, or release.

## Revision records

Specific releases, pull requests, review records, and revision notes retain
their own local history. They may name the work or review relevant to that
revision without needing to repeat this full project-wide record.

## Localisation

English is the canonical protocol language. Locale documentation may explain
the same project facts in a natural local form while preserving the relevant
paths, machine fields, and protocol boundaries.

[Return to the documentation index](README.md).
46 changes: 46 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# CapstanAI LabNote documentation

The repository README helps you decide whether LabNote fits your work and get
a copy. This page helps you find the exact guidance you need once you have
one.

**English** | [简体中文](../locales/zh-CN/docs/README.md)

## Start

- [Choose a setup route](ACQUISITION.md) — use the repository as a GitHub
template, clone or copy it locally, or ask an AI to guide you through the
safest route it can support.
- [Follow the first-use walkthrough](quickstart.md) — begin in a copied
workspace without learning the entire structure first.
- [Start an AI at the entrypoint](../AI_ENTRYPOINT.md) — the controlled
reading route for a session working inside LabNote.

## Work

- [Make a routine deposit](../lobby/ROUTINE_DEPOSIT_QUICKSTART.md) — place a
normal piece of work in the right route with the minimum useful record.
- [Understand review and decisions](review_workflow.md) — see how a response
becomes a reviewed outcome.
- [Understand visitor and session identity](visitor_lobby_model.md) — learn
what session records mean in a live workspace.
- [Understand message routing](message_routing_model.md) — follow the model
for messages between sessions or roles.
- [Understand registry records](REGISTRY_RECORDS.md) — see what the durable
register records are for.

## Keep the workspace safe

- [Read the storage policy](storage_policy.md) — keep the ledger small,
inspectable, and appropriate to its visibility.
- [Read the document-deposit policy](DOCUMENT_DEPOSIT_POLICY.md) — handle
documents and binaries without turning LabNote into a general file dump.
- [Read the security guidance](../SECURITY.md) — do not put credentials,
tokens, keys, or unintended private material into the wrong workspace.

## Understand the project

- [LabNote alongside context files and model memory](WHY_LABNOTE.md) — how a
visible project ledger complements those two kinds of AI support.
- [Project provenance](PROJECT_PROVENANCE.md) — how human maintainers and
managed AI assistance contributed to the project.
43 changes: 43 additions & 0 deletions docs/WHY_LABNOTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# LabNote alongside context files and model memory

LabNote keeps selected project continuity in visible files. It complements a
model's context window and repository instruction files; it does not replace
them.

## Model context is not project continuity

A long context window can help a model read more in one sitting. It does not,
by itself, decide what should remain important after the session, show the next
tool why a decision was made, or create a selective record that a human can
inspect.

LabNote does not enlarge a model’s native memory or silently capture your
conversations. A human or an AI session deliberately writes the record. That is
why the trail can be checked, corrected, reviewed, and carried to another
tool.

Context length is useful. Project continuity is a separate job.

## Context files set local rules

Files such as `AGENTS.md` or `CLAUDE.md` are useful ways to tell an AI about a
repository: where important files are, how to run tests, and what local rules
apply.

LabNote complements them. Its job is to route ongoing project work: where a
session begins, what it should read, where it may leave work, how that work is
reviewed, and when the session should stop and ask.

A context file tells an AI what kind of repository it is in. LabNote gives it a
route through the work happening there.

## Use the smallest useful amount

If a one-shot answer is enough, use the best tool available and get on with it.
If a plain folder is enough, use a plain folder.

Use LabNote when you want a visible working trail that can grow with the
project without becoming a hidden service or a second brain. Start with the
smallest record that will genuinely help the next session.

[Return to the documentation index](README.md).
Loading
Loading