You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(landing): align commands surface and link tutorial as canonical onboarding (#28)
- Add a tutorial admonition at the top of the manual quick-start and list it
first in the reading order; surface the tutorial early in the README too.
- Rewrite the docs/index.md Commands section to reflect what is actually wired
today: new Data acquisition + tracking group (get, add, mv, rm, queue, mark),
move propose-alignment under semantic mapping, separate annotate/config from
the standard build path, and split out a Stubs / not yet wired group
(discover, benchmark, read, chat, search).
- Point readers from `biotope add` to the `.biotope.yaml` review +
`annotate apply` loop for curated metadata that does not fit as CLI flags,
and fix the annotate entry to describe each subcommand's actual scope
(dataset/record-set, not field-level).
- README quick-start now mirrors the tutorial's spine (uvx init -> uv sync ->
get -> add -> queue -> map -> build -> create_knowledge_graph.py -> view)
and drops `annotate apply` from the minimum path.
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
`biotope init` is a pure scaffolder. All non-autogeneratable metadata is supplied as CLI flags — by a user or an agent reading `AGENTS.md`. Semantic decisions (which record set, which fields, which transforms) are made by the human or copilot; biotope only enumerates options, validates, and previews.
@@ -70,14 +78,17 @@ The agent surface is `AGENTS.md` (template lives at `biotope/templates/AGENTS.md
70
78
71
79
```
72
80
init project scaffolding
81
+
get add mv rm acquisition + tracking (baker writes croissants)
82
+
queue mark pipeline-state dashboard + manual transitions
discover benchmark scaffolded but not yet wired into the standard flow
91
+
read chat search promises / auxiliary
81
92
```
82
93
83
94
`biotope describe` and the heuristic `biotope propose-mapping` were removed/deprecated. Intent capture is now `biotope map --entity ... --relation ...`; scaffolding is `biotope map scaffold`. `propose-mapping` remains as a deprecated alias for the scaffold subcommand.
-`biotope get <url>` — download a file (optionally into `--output-dir`) and, unless `--no-add`, track it.
74
+
-`biotope add <path>` — stage data files or rooted directories; baker writes the Croissant entry under `.biotope/datasets/`. `--derived-from` records provenance for human/agent-extracted derivatives. For curated metadata that doesn't fit as CLI flags (descriptions, citations, per–record-set fields), `add` also drops a `.biotope.yaml` scaffold next to the dataset — review it, then run `biotope annotate apply <dir>` to merge it into the manifest.
75
+
-`biotope mv` / `biotope rm` — move or untrack files and update metadata paths.
76
+
-`biotope queue` — show every dataset grouped by pipeline state (`raw` / `processed` / `mapped`). The recommended dashboard during a build.
77
+
-`biotope mark <dataset> <status>` — manually set a dataset's `biotope:status`.
78
+
64
79
### Semantic mapping
65
80
66
81
-`biotope map` — bare command. If any intent flag (`--purpose`, `--entity`, `--relation`, `--source`, `--notes`, `--clear-*`, `--show`) is passed, it updates `project.yaml` non-interactively. Otherwise it launches the guided wizard.
67
82
-`biotope map inspect <croissant>` — deterministic field catalogue + sample rows. `--json` for agents.
68
83
-`biotope map scaffold <croissant>` — emit an unresolved mapping scaffold with an inspector comment appendix.
69
84
-`biotope map preview [<mapping>]` — validate a (partial) mapping; show projected BioCypher schema + sample tuples. `--json` for agents.
-`biotope build` — materialise a runnable BioCypher project from mappings + alignment. Emits `config/schema_config.yaml` (with `namespace` and autogenerated `input_label`) and per-mapping generated Python under `build/generated/<stem>/`.
86
-
-`biotope view` — node/edge counts for the most recent build.
87
-
-`biotope benchmark` — quality/coverage metrics (skeleton in v1).
98
+
-`biotope view` — node/edge counts for the most recent build (or project competence questions if no build yet).
99
+
100
+
### Annotation + project config
101
+
102
+
-`biotope annotate` — `apply` (merge a curated `.biotope.yaml` scaffold into a dataset's Croissant manifest, with optional `--set dataset.<field>=…` / `--set record_set.<field>=…` overrides), `edit` (interactive annotation), `load` (sample records via the manifest), `validate` (mlcroissant validation).
-`biotope discover` — rank registered adapters and local Croissant files against `required_entities`. Exists as a CLI entry but the registry surface is not yet wired into the recommended workflow; the tutorial does not use it.
108
+
-`biotope benchmark` — quality/coverage metrics. v1 stub: emits a skeleton JSON object so downstream tooling can structure-test against it. Real metric implementations land iteratively.
-`biotope search` — registry search across MCP / biotools. Auxiliary; not used in the standard build path.
88
112
89
113
### Deprecated
90
114
91
115
-`biotope describe` — removed; folded into `biotope map` intent flags.
92
116
-`biotope propose-mapping` — deprecated alias for `biotope map scaffold`. The old heuristic ("one RecordSet per node type, FK fields as edges") is gone; the alias now produces an unresolved scaffold for human/agent completion.
0 commit comments