Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d0bf088
docs: mirror the MkDocs nav in the README table of contents
Oct 14, 2026
205e931
docs: restructure the README around installing and configuring
Oct 14, 2026
2acd940
docs: update README descriptions for the moved Using ColdFront sections
Oct 15, 2026
0efc90a
docs: say the object store credential is set in each database
Oct 15, 2026
deed31b
docs: use the <role_name> placeholder in the README grant step
Oct 15, 2026
5831c68
docs: run the Lakekeeper migration as the lakekeeper user in the README
Oct 15, 2026
89d4b46
docs: take the warehouse ID from the create response in the README
Oct 15, 2026
2390d6f
docs: warn when the warehouse ID is empty in the README
Oct 15, 2026
30d7fc9
docs: bind Lakekeeper to loopback in the README evaluation steps
Oct 15, 2026
44c1e31
docs: name the README Table of Contents as the index in CLAUDE.md
Oct 15, 2026
0d2a3ab
docs: describe how README.md and docs/index.md relate in CLAUDE.md
Oct 15, 2026
854c5fd
docs: say the Iceberg cold tier applies to tiered and decoupled modes…
Oct 15, 2026
4ce297c
docs: skip the namespace request when the warehouse ID is empty in th…
Oct 15, 2026
8f68c9f
docs: set duckdb.postgres_role and create its role in the README inst…
Oct 15, 2026
9d73c50
docs: set coldfront.warehouse to wh in the README install steps
Oct 15, 2026
bc2fa76
docs: say when the Next Steps list needs updating in CLAUDE.md
Oct 15, 2026
f515164
docs: initialize, configure, and restart PostgreSQL in the README pac…
Oct 15, 2026
0ddb19c
docs: list a PostgreSQL server in the README bare-metal requirements
Oct 15, 2026
4644c5f
docs: say the role is created once and the extensions in each database
Oct 15, 2026
18edfd1
docs: turn off DuckDB extension autoinstall in the README bare-metal …
Oct 15, 2026
694a72f
docs: install and start PostgreSQL before ColdFront in the README pac…
Oct 15, 2026
682433a
docs: create the Debian cluster and check the server in the README pa…
Oct 15, 2026
e2bc6be
docs: split the README package steps and install the tools and Lakeke…
Oct 15, 2026
6329121
docs: bullet the settings notes and add next-step links in the README…
Oct 15, 2026
3444149
docs: link SeaweedFS's docs for the host object store step in the README
Oct 15, 2026
5414ab5
docs: connect as a superuser in the README bare-metal steps
Oct 20, 2026
b737ad4
docs: run make install with sudo in the README bare-metal steps
Oct 20, 2026
7a58bd6
docs: say how to recover the warehouse ID in the README
Oct 20, 2026
aacbe2d
docs: say the pgEdge repository requires a certificate in the README
Oct 20, 2026
763111c
docs: create the Lakekeeper catalog role as a superuser in the README
Oct 20, 2026
1ec85d3
docs: publish the Docker stack's ports on loopback only in the README
Oct 20, 2026
6ab7a24
docs: use a generated password for the Lakekeeper catalog role in the…
Oct 20, 2026
daa2047
docs: say the deployment YAML is an import input, not the settings so…
Oct 20, 2026
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
4 changes: 2 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ Snapshots of upstream state for the next major moves. Re-verify before acting on

## Documentation
- User docs live in `docs/` as a MkDocs site (pgEdge MkDocs structure); `README.md` is the GitHub landing/TOC. Build with `mkdocs build --strict` — it must pass with no warnings.
- Keep `README.md` and `docs/index.md` near-identical, EXCEPT `docs/index.md` is user-facing and omits the developer-specific content that belongs only in a GitHub README: CI badges, build-from-source internals, the project-structure tree, dependency/build tables, and author/contributor info.
- Three indexes point at the pages in `docs/`, each with its own focus: the `mkdocs.yml` `nav:` (everything, including changelog, license and `formal/`), the `README.md` Documentation table (one terse row per guide), and the `docs/index.md` Next Steps list (prose, user-facing, top-level guides only; the per-mode deep dives are reached through `docs/architecture_guides/index.md`, which lists them). Adding, renaming, or removing a guide under `docs/` means updating all three in the same commit; adding a deep dive means the nav, the README table, and the list in `docs/architecture_guides/index.md`. `mkdocs build --strict` passes on a page no index links, so it will not catch this: check by listing `docs/*.md` against each index.
- `README.md` and `docs/index.md` open with the same introduction (what ColdFront is, its three operating modes, and the bakery protocol), differing only in the warning-box syntax and link paths each format needs; change both together. After the introduction they serve different readers: `README.md` is the GitHub landing page, with the install-and-configure walkthrough, support links, and developer content (CI badge, dependencies, versioning, project structure, author); `docs/index.md` is the docs-site landing page and points readers to the walkthroughs and guides.
- Three indexes point at the pages in `docs/`, each with its own focus: the `mkdocs.yml` `nav:` (everything, including changelog, license and `formal/`), the `README.md` Table of Contents (mirrors the nav's titles, order and nesting, with a short description after each link), and the `docs/index.md` Next Steps list (prose, user-facing, top-level guides only; the per-mode deep dives are reached through `docs/architecture_guides/index.md`, which lists them). Adding, renaming, or removing a guide under `docs/` means updating the nav and the README Table of Contents in the same commit, plus the `docs/index.md` Next Steps list when the guide is a top-level user guide; adding a deep dive means the nav, the README Table of Contents, and the list in `docs/architecture_guides/index.md`. `mkdocs build --strict` passes on a page no index links, so it will not catch this: check by listing `docs/*.md` against each index.
- Internal/scratch docs (bench, experimental, hardening, comparison, backlog, scale-test, E2E) are gitignored and NEVER pushed to GitHub; never reference them from published docs.
- ARCHITECTURE docs are reference material, not work logs: brief, present-tense, no history ("we used to…", version churn), no rejected-alternative narration. Keep the *why* (rationale that explains the design); cut the journey.
- One home per topic, no duplication across docs: shared day-to-day usage and the partition CLI in `docs/using_coldfront/index.md`; each mode's own guide in `docs/usage_tiered.md`, `docs/usage_decoupled.md`, and `docs/usage_partitioner.md`; PostgreSQL/ColdFront config in `docs/configuration.md`; Lakekeeper install/config/bootstrap in `docs/configure_lakekeeper.md`; build-from-source and testing/CI in `docs/installation.md`; storage-backend setup in `docs/object_store.md`; deep dives in `docs/architecture_guides/index.md` and `docs/architecture_tiered.md`/`docs/architecture_decoupled.md`/`docs/architecture_vectors.md`. When moving a section, fix every cross-anchor that pointed at it.
Expand Down
Loading
Loading