docs(user): restructure user docs into topic sections (Phase 1)#223
Merged
Conversation
Move the 23 flat docs/user/*.md files into topic subdirectories so the user guide is organized by area (schema, queries, search, branching, cli, operations, clusters, concepts, reference) instead of a flat list. This is a pure structural move — whole files relocated, every cross-doc link recomputed, no prose rewrites or content splits (those follow in Phase 2). - 19 `git mv`s (install.md, deployment.md stay top-level); history preserved (renames detected at 92–100% similarity). - All intra-doc links, AGENTS.md's topic table (52 pointers), and the docs/dev + docs/releases back-links recomputed via relpath from each file's new location. - docs/user/index.md rewritten as a sectioned nav hub. - Fixed 5 doc-path references in Rust (comments + two user-facing server settings error strings) to point at the new locations. Verified: zero broken .md links across tracked docs; check-agents-md.sh green (with the untracked scratch docs set aside); touched crates build. Note: the public site (omnigraph-web) imports docs/ via a flat-only script; its import-docs.mjs needs a subdir-aware update before the next re-sync. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Comment on lines
+25
to
+27
| | Use vector / full-text / hybrid search | [search/indexes.md](search/indexes.md) | | ||
| | Generate embeddings | [search/embeddings.md](search/embeddings.md) | | ||
| | Build and use indexes | [search/indexes.md](search/indexes.md) | |
There was a problem hiding this comment.
Duplicate nav row — both goals resolve to the same file
"Use vector / full-text / hybrid search" (line 25) and "Build and use indexes" (line 27) both link to search/indexes.md. The new hub now has two rows for the same destination under different goal descriptions, which will confuse readers who expect each row to lead somewhere distinct. One row should be removed, or the goals should be differentiated with different target files (e.g., a future search/overview.md once Phase 2 splits the content).
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Pure structural move of the 23 flat
docs/user/*.mdfiles into topicsubdirectories, so the user guide is organized by area instead of a flat
list. Whole files relocated, every cross-doc link recomputed — no prose
rewrites, no content splits (those are Phase 2).
How
git mvs (install.md,deployment.mdstay top-level). Historypreserved — renames detected at 92–100% similarity.
relpathfrom each file's new location:intra-doc links, AGENTS.md's topic table (52 pointers), and the
docs/dev+docs/releasesback-links.docs/user/index.mdrewritten as a sectioned nav hub.settings.rsserver error strings) to point at the new locations.Verification
.mdlinks across tracked docs (resolve-every-link sweep).scripts/check-agents-md.shgreen (every canonical doc linked from anindex; all index links resolve).
Follow-ups (not in this PR)
queries/→ mutations + search overview, splittime-travel out of
branching/, add quickstart / concepts / merge / configpages, expand the
auditstub.omnigraph-web) importsdocs/via aflat-only
import-docs.mjs; it needs a subdir-aware update before the nextre-sync. The site stays on its last good sync until then.
🤖 Generated with Claude Code
Greptile Summary
This is a pure structural reorganization of the 23 flat
docs/user/*.mdfiles into topic subdirectories (branching/,cli/,clusters/,concepts/,operations/,queries/,reference/,schema/,search/), with all cross-document links recomputed and five stale doc-path references in Rust source updated. No prose content was changed.git mvpreserve history;install.mdanddeployment.mdstay top-level;docs/user/index.mdis rewritten as a sectioned navigation hub.AGENTS.md(52 pointers updated with old paths as display text and new paths as hrefs),docs/dev/back-links, and all intra-user-doc relative paths.settings.rs, one--asdoc comment incli.rs, one constant doc comment inquery.rs, and one test module comment inordering.rs.Confidence Score: 4/5
Safe to merge after fixing the duplicate nav row in docs/user/index.md; all Rust changes are doc-comment strings only and the link sweep is thorough within the repo
The new nav hub has two rows in "Schema & queries" that both resolve to search/indexes.md under different goal descriptions — a copy-paste slip that leaves the index slightly misleading for the first readers of the restructured docs. Everything else looks correct; the CI link check and build passing confirm structural integrity within the repo.
docs/user/index.md — the duplicate "Build and use indexes" / "Use vector / full-text / hybrid search" rows both targeting search/indexes.md should be resolved before merge
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD UI[docs/user/index.md\nnav hub] --> CLI[cli/\nindex - reference] UI --> SCH[schema/\nindex - lint] UI --> QRY[queries/\nindex] UI --> SRC[search/\nindexes - embeddings] UI --> BRN[branching/\nindex - transactions - changes] UI --> OPS[operations/\nserver - maintenance - policy - audit - errors] UI --> CLU[clusters/\nindex - config] UI --> CON[concepts/\nstorage] UI --> REF[reference/\nconstants] UI --> TOP[top-level\ninstall - deployment] AGENTS[AGENTS.md] -->|52 hrefs updated| UI DEV[docs/dev/**] -->|back-links updated| UI RUST[Rust src\nsettings - cli - query - ordering] -->|5 comment paths| UIComments Outside Diff (1)
docs/user/index.md, line 1-27 (link)omnigraph-cookbooksrepoThe PR's link sweep covered the
omnigraphrepo, but two backtick prose references in the companion skills repo still point at the old flat paths. Inskills/omnigraph-best-practices/references/cluster.md(lines 130–131),docs/user/cluster.mdanddocs/user/cluster-config.mdshould now bedocs/user/clusters/index.mdanddocs/user/clusters/config.md. They are prose strings (not hyperlinks), so they won't fail a link checker, but any agent or developer reading those skills will try to navigate to paths that no longer exist.Reviews (1): Last reviewed commit: "docs(user): restructure user docs into t..." | Re-trigger Greptile