Repository navigation
Refresh skills and operator guides for 0.13 - #892
aaltshuler wants to merge 1 commit into
Conversation
|
Keeping this PR open: the current head The other required checks completed successfully. This is a CI completion blocker, not evidence of a failing test assertion. Complete the Azure job before merging; do not waive the gate. No rerun or workflow change was made as part of this issue-cleanup pass. |
Review of
|
| Commit | Command | Result |
|---|---|---|
2990fa3 (head) |
python3 scripts/check-docs.py |
pass (213 Markdown files) |
2990fa3 |
bash scripts/check-agents-md.sh |
pass |
2990fa3 |
typos v1.50.1 (CI pin) |
pass |
main 4d7536d6 |
cargo test -p omnigraph-cli --locked --bin omnigraph skill::tests |
5 passed, 0 failed |
main 4d7536d6 + this PR's SKILL.md and references/commands.md (temporary overlay, reverted) |
same command | 2 passed, 3 failed: no ## Command Index section; no ## CLI Reference (condensed) section; SKILL.md must state internal-schema 16 (serves v14 to v16) |
main 4d7536d6 |
git merge --no-commit 2990fa3 (aborted) |
5 conflicted files, 13 hunks |
Exact-commit CI: 24 checks pass and 5 are skipped. Azurite Azure Integration was cancelled at its 90-minute limit while it compiled, and the run concluded cancelled. The PR changes no Rust code, so that job gives no evidence either way. A rebase makes a new head, which needs a fresh full run. Do not waive the gate.
Regression proof: this PR is documentation only, with no engine change. No GQT or Rust regression applies to its prose fixes, so I checked them by code inspection only. The only executable contract for this content is the CLI skill guard on main, and the PR's content fails it (the overlay row in the table).
Limits: I did not run the full workspace tests or a cargo build at the head. I did not check every sentence in clusters/index.md, deployment.md, migrations.md or aliases.md against the code; I checked the claims listed here only. No performance claims are made.
| @@ -0,0 +1 @@ | |||
| - Agent skills and deployment guides now describe the current 0.13 workflows, exact receipts and live configuration updates. Obsolete commands, historical workarounds and duplicated migration instructions have been removed. | |||
There was a problem hiding this comment.
Blocking (finding 3). docs/dev/documentation.md (Release notes) says "No PR number or release number is needed". This note says "the current 0.13 workflows", but it would ship in the 0.14 notes. Fix: describe the outcome without a version, for example: "The agent skill and deployment guides describe live configuration updates and exact receipts, and no longer list removed routes and flags."
|
|
||
| One mutation-capable process per cluster is supported. Direct apply, direct | ||
| cluster writes and the server share exclusive writer admission. They leave the | ||
| lock after exit, including a clean exit; a successful shutdown does not itself |
There was a problem hiding this comment.
Blocking (finding 4). This text was true at 0.13. On main it is false after #899 and #893.
main's docs/user/deployment.md now says: on local storage and S3, a clean server shutdown closes its storage scope, waits for accepted writes, and releases its own cluster admission. Azure still keeps the lock. A fresh S3 bootstrap can pass ownership to the first server with --bootstrap-handoff.
An agent that follows this text, or the force-unlock-before-serving step at line 99, would look for a lock that is no longer there. Fix: on rebase, state which writers keep admission: direct apply, direct writes, uncertain or interrupted shutdown, and Azure. Link deployment.md#writer-topology instead of restating the procedure. main's own cluster.md and server-policy.md still have the old sentence, so fix it there too.
| # OmniGraph | ||
|
|
||
| Check `omnigraph version` and the relevant command's `--help`. These instructions | ||
| cover 0.13 only, serving storage format 14. HTTP clients send and verify `Omnigraph-Http-Api: 0.13`; changing |
There was a problem hiding this comment.
Blocking (findings 2 and 3). On main 4d7536d6 this file fails two CLI guard tests in crates/omnigraph-cli/src/skill.rs:
skill_condensed_reference_names_every_top_level_commandpanics withno ## CLI Reference (condensed) section. This rewrite deletes that section.skill_states_the_storage_formats_this_binary_reportspanics withSKILL.md must state internal-schema 16 (serves v14 to v16).mainnow serves v14 to v16, not format 14 only.
main also ships a version-matched skill (omnigraph skill export / skill show). "Cover 0.13 only" is therefore the wrong shape. Fix: rebase onto main. Keep the ## CLI Reference (condensed) section and the exact omnigraph version storage line. Tell the reader to check omnigraph version instead of naming a release.
| @@ -1,423 +1,195 @@ | |||
| # Reference Commands | |||
| # Command Reference | |||
There was a problem hiding this comment.
Blocking (finding 2). On main, skill_command_index_lists_every_public_command parses a ## Command Index table in this file. It requires the table to equal the clap tree's public command paths exactly. This rewrite has no such section, so the test panics with no ## Command Index section. This file also conflicts with main in 5 hunks.
Optional (finding 5). At this head, repair and profile are public commands (crates/omnigraph-cli/src/cli.rs), but no skill file names them now. Fix: rebase onto main's commands.md. Keep the Command Index, and apply only the factual corrections on top of it.
| resume observation by the original deployment ID. For conditional data writes, | ||
| use the commit captured with the read and re-read after a precondition failure. | ||
|
|
||
| ## Read the relevant reference |
There was a problem hiding this comment.
Optional (findings 6 and 7).
mainmoved the schema-design guidance (Gruber criteria, provenance) intoreferences/schema-design.md(docs(skill): consolidate schema design guidance and add multi-agent principles #811).mainnow has 14 references, andcrates/omnigraph-server/src/mcp.rsserves them as MCP resources by key. On rebase, linkschema-design.mdin this table.- This rewrite deletes the whole Common Gotchas table. Several rows are still true on
main:inithas no--json, enums are inline only (enum_typeinschema.pest), andlimittakes an integer literal. Agents use that table to map error text to a fix. Keep the rows that are still true and remove only the version-history rows.
| refusal keeps admission open. The error's HTTP status or storage category alone | ||
| does not prove whether effects started. | ||
|
|
||
| Drain does not prove native storage I/O has settled. Even a clean exit retains |
There was a problem hiding this comment.
Blocking (finding 4). "Even a clean exit retains the cluster lock" contradicts main after #899. There, a settled clean shutdown on local storage or S3 releases admission, and only Azure and unsettled exits keep it. This file also conflicts with main in 2 hunks. Fix: on rebase, keep main's shutdown-release paragraph and apply this PR's simplifications around it.
| format, and every cluster-managed graph below v14, is refused and takes the | ||
| [export/import rebuild](#rebuild) with the binary that wrote the graph. | ||
| Check the [release notes](../../releases/) for storage and index compatibility. | ||
| OmniGraph 0.13 opens storage format v14. Normal open never migrates a graph. |
There was a problem hiding this comment.
Blocking (finding 3). On main this line conflicts with "Normal open accepts storage formats v14 to v16". main also documents the stamp-v14-to-v16 route, which as commit, commit publish, commit drop and as unattached branch require. The route table below has no row for v14/v15 to v16. Fix: on rebase, build the table from main's format range. Name no release in the heading, or name the release the binary reports.
Review of
|
| Commit | Command or check | Result |
|---|---|---|
2990fa3 |
python3 scripts/check-docs.py (after pip install -r scripts/requirements-docs.txt) |
pass, 213 Markdown files |
2990fa3 |
bash scripts/check-agents-md.sh |
pass, 52 links, 50 docs |
85a46138 merge 2990fa3 |
git merge --no-commit --no-ff in a detached worktree, then git merge --abort |
7 conflicted files, 19 hunks; migrations.md merged and states format 14 only |
2990fa3 and 85a46138 |
string check of the three skill.rs predicates |
main has ## Command Index, ## CLI Reference (condensed), and `internal-schema 16 (serves v14 to v16)`. This head has none of them |
| GitHub, this head | check rollup | 24 checks succeeded, 5 skipped, Azurite Azure Integration cancelled. mergeable is CONFLICTING |
Exact-commit CI: the succeeded checks ran on 2990fa3. Azurite Azure Integration was cancelled at its job limit while it compiled. The author note on this pull request says the same. This pull request changes no Rust code, so that job is not evidence of a test failure and not evidence of a pass. Do not waive it. A rebase is a new head and needs a new full run.
Regression proof: this pull request changes documentation only. It does not change query rows, counts, column types, or engine errors, so a .gqt case cannot express the defect. The executable contract for this content is the CLI skill guard on main. I did not run cargo test: a build of omnigraph-cli at 85a46138 pulls the Lance 13 workspace, and I did not compile it. The failure mode is the test source itself. Each test panics when its section or its exact storage line is absent, and those strings are absent at this head and present on main.
Limits: I did not run typos (the typos binary is not installed here; CI pins v1.50.1). I did not run the workspace tests or a cargo build. I did not check every sentence in docs/user/clusters/index.md, references/aliases.md, references/queries.md, or references/data.md. I checked the claims in this comment. No performance claim is made. The "does not re-embed stored rows" sentence in the embeddings edit was not traced through the embed pipeline.
Refresh the OmniGraph skill and operator guides for the released 0.13 workflows. Replace accumulated restart workarounds, removed HTTP routes/flags, and duplicate instructions with current live deployment, exact-receipt, policy/provider, and graph lifecycle guidance.
Keep all 13 skill reference filenames stable for the MCP bundle. This removes roughly 1,100 net lines while correcting policy-update, embedding-provider, and served-plan documentation.
Validation: skill validator, documentation checker (213 Markdown files), agent-guide links, typos, and diff whitespace all pass. No engine behavior changes.