Skip to content

docs: clean-slate v1 — drop migration prose, milestone framing, 0.x caveats#90

Merged
theagenticguy merged 4 commits into
mainfrom
fix/docs-clean-slate-v1
May 10, 2026
Merged

docs: clean-slate v1 — drop migration prose, milestone framing, 0.x caveats#90
theagenticguy merged 4 commits into
mainfrom
fix/docs-clean-slate-v1

Conversation

@theagenticguy
Copy link
Copy Markdown
Owner

Summary

The docs site now reads as if v1 is the only reality. There's no installed-base on a prior version and nothing to "migrate from" — every install starts on the LadybugDB default with the DuckDB single-file layout as a fallback when the binding cannot load. Per user directive: "assume no one but me has used this so far. clean slate based on current head of repo."

Changes (4 commits)

  1. 40b6886 drop migrating-from-duckdb guide + cross-refsgit rm packages/docs/src/content/docs/guides/migrating-from-duckdb.md plus references in configuration.md, indexing-a-repo.md, storage-backend.md, and the llms-txt customSet description in astro.config.mjs.
  2. e05cd50 reframe storage as default+fallbackstorage-backend.md, overview.md, determinism.md, monorepo-map.md, start-here/install.md, start-here/quick-start.md, start-here/what-is-opencodehub.md, reference/configuration.md, guides/indexing-a-repo.md, guides/troubleshooting.md. "M7 default-flip" / "legacy default" / "since v1.0" prose → "default + opt-in fallback when @ladybugdb/core cannot load."
  3. 63a6c0b drop M3-M7 milestone framingarchitecture/cross-repo-federation.md, architecture/lessons.md, architecture/adrs.md, mcp/overview.md, mcp/prompts.md. Reframed ADR cross-references as "records this decision" rather than "M7 delivered X"; rewrote prompts page as design rationale rather than removal narration.
  4. cd388bb drop 0.x BREAKING-change caveats from contributingcontributing/release-process.md, contributing/commit-conventions.md. "While OCH sits on 0.x.y..." → forward-looking rule: feat! / BREAKING CHANGE: bumps major.

Validation

  • pnpm -F @opencodehub/docs build — clean, 64 → 63 pages (one deletion), all internal links valid
  • bash scripts/check-banned-strings.sh — PASS
  • rg 'AC-[A-Z]-[0-9]|T-M[0-9]+-[0-9]+|W-[A-Z]-[0-9]+|S-[A-Z]-[0-9]+|E-[A-Z]-[0-9]+|CL-[A-Z]+' packages/docs/src/ — zero hits
  • rg 'migrat\|previously\|formerly\|legacy default\|0\.x' packages/docs/src/ — zero prose hits (pnpm 10.x toolchain references remain — those describe pnpm's major version line, not OCH's release line)

Test plan

  • CI green
  • After merge, Pages workflow re-deploys and the site reads forward-only

The site reads as if v1 is the only reality — there is no installed
base on a prior layout to migrate from. Delete the migration guide and
its inbound links from configuration.md, indexing-a-repo.md, and
storage-backend.md. Update the llms-txt customSet description so it no
longer advertises a migration guide.
…flip

LadybugDB is the default; the single-file DuckDB layout is the opt-in
fallback for environments where the @ladybugdb/core binding cannot
load. Drop "M7 default-flip", "legacy default", and "what's new" prose
across storage-backend, overview, determinism, monorepo-map, install,
quick-start, what-is-opencodehub, configuration, indexing-a-repo, and
troubleshooting. ADR 0013 is now described as recording a decision,
not as a flip event.
… how it evolved

Site prose now describes the current shape of the system without
pinning behavior to milestones. ADR cross-references are reframed as
"records this decision" rather than "this milestone delivered X".
Trims the canned-prompts page so it explains why playbooks live as
skills instead of narrating a removal event.
Conventional Commits is a reference; the rule list does not need a
"while we're on 0.x" preamble. feat! and BREAKING CHANGE: footer both
bump the major version — that is the rule, stated forward-looking.
@theagenticguy theagenticguy merged commit 7f1addf into main May 10, 2026
37 checks passed
@theagenticguy theagenticguy deleted the fix/docs-clean-slate-v1 branch May 10, 2026 19:32
@github-actions github-actions Bot mentioned this pull request May 10, 2026
theagenticguy added a commit that referenced this pull request May 10, 2026
…aveats (#90)

## Summary

The docs site now reads as if v1 is the only reality. There's no
installed-base on a prior version and nothing to "migrate from" — every
install starts on the LadybugDB default with the DuckDB single-file
layout as a fallback when the binding cannot load. Per user directive:
"assume no one but me has used this so far. clean slate based on current
head of repo."

## Changes (4 commits)

1. **`04db651` drop `migrating-from-duckdb` guide + cross-refs** — `git
rm packages/docs/src/content/docs/guides/migrating-from-duckdb.md` plus
references in `configuration.md`, `indexing-a-repo.md`,
`storage-backend.md`, and the llms-txt customSet description in
`astro.config.mjs`.
2. **`7c96429` reframe storage as default+fallback** —
`storage-backend.md`, `overview.md`, `determinism.md`,
`monorepo-map.md`, `start-here/install.md`, `start-here/quick-start.md`,
`start-here/what-is-opencodehub.md`, `reference/configuration.md`,
`guides/indexing-a-repo.md`, `guides/troubleshooting.md`. "M7
default-flip" / "legacy default" / "since v1.0" prose → "default +
opt-in fallback when `@ladybugdb/core` cannot load."
3. **`8bec91f` drop M3-M7 milestone framing** —
`architecture/cross-repo-federation.md`, `architecture/lessons.md`,
`architecture/adrs.md`, `mcp/overview.md`, `mcp/prompts.md`. Reframed
ADR cross-references as "records this decision" rather than "M7
delivered X"; rewrote prompts page as design rationale rather than
removal narration.
4. **`d0db801` drop 0.x BREAKING-change caveats from contributing** —
`contributing/release-process.md`, `contributing/commit-conventions.md`.
"While OCH sits on 0.x.y..." → forward-looking rule: `feat!` / `BREAKING
CHANGE:` bumps major.

## Validation

- `pnpm -F @opencodehub/docs build` — clean, 64 → 63 pages (one
deletion), all internal links valid
- `bash scripts/check-banned-strings.sh` — PASS
- `rg
'AC-[A-Z]-[0-9]|T-M[0-9]+-[0-9]+|W-[A-Z]-[0-9]+|S-[A-Z]-[0-9]+|E-[A-Z]-[0-9]+|CL-[A-Z]+'`
packages/docs/src/ — zero hits
- `rg 'migrat\|previously\|formerly\|legacy default\|0\.x'`
packages/docs/src/ — zero prose hits (pnpm 10.x toolchain references
remain — those describe pnpm's major version line, not OCH's release
line)

## Test plan

- [ ] CI green
- [ ] After merge, Pages workflow re-deploys and the site reads
forward-only
@github-actions github-actions Bot mentioned this pull request May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant