docs: consolidate on Nextra, drop legacy docs/ folder#4
Merged
Conversation
User-facing documentation now lives in a single place: the Nextra site
under apps/docs/ (published to docs.duckcode.ai). The legacy docs/ folder
had 27 half-migrated files with stale content, broken cross-links, and
references to deleted commands — confusing for new users.
- Rewrite root README from 487 lines → ~55 lines. Single install path
(npx create-dql-app), then point at docs.duckcode.ai. Drop the 25
broken deep-links into docs/.
- Port 3 pages that were missing from Nextra:
* guides/faq.mdx
* reference/project-layout.mdx
* reference/compatibility.mdx
- Update reference/file-formats.mdx: cdql.yaml → dql.config.json (matches
what v1.0.1 actually ships), clarify .dqlnb is the current notebook
format, not legacy.
- Delete 27 legacy docs/ files: the 01-/02-/03-/04-/05- numbered
directories, migration-guides/, examples/, dql-language-spec, faq,
compatibility, project-config, project-structure, v1-support-scope,
publishing, repo-testing, data-sources. Content is covered in Nextra
or was itself stale.
- Keep docs/oss-readiness-checklist.md (internal maintainer checklist).
- Move examples/jaffle-shop-lineage-demo.dqlnb to examples/gallery/ so
all example assets live in one place.
- Rewrite docs/README.md as a thin pointer to the Nextra site.
- Nextra builds clean: 28 pages, link-check passes with 0 broken links.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
KKranthi6881
added a commit
that referenced
this pull request
Apr 23, 2026
…r abstraction) Closes the v1.2.1 gap audit — 9 fixes, ordered by severity. No behavior changes beyond the #2 email-delivery correction; the rest add logging, ignore patterns, and a provider-extension point. Critical: - #1 ignore .dql/runs/ and .dql/cache/ (root + `dql init` scaffold) - #2 email notifier returns delivered:false in stub mode (was lying) Bugs: - #3 GET /api/blocks/body endpoint for bound-cell reloads - #5 /api/schema returns 500 + fallback instead of silent file-only - #6 log malformed scheduler run records to stderr - #7 replace empty catches in runtime/html emitters with console.warn Smells: - #8 move LLM providers into providers/; add LLMProvider type alias - #9 `dql schedule stop` via pidfile #4 was a false-positive — bound-cell lineage is already wired via the manifest builder's pathToBlockName lookup; comment updated. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
User-facing documentation is now in one place: docs.duckcode.ai (source:
apps/docs/Nextra site). The legacydocs/folder had 27 half-migrated files — stale content, broken cross-links, references to deleted commands, and 25 broken deep-links from the root README. Confusing for new users.What changed
Root README (487 → ~55 lines)
npx create-dql-app→npm install && npm run notebookdocs/Ported 3 pages that were genuinely missing from Nextra
guides/faq.mdx— common questionsreference/project-layout.mdx— what goes inblocks/,notebooks/, etc.reference/compatibility.mdx— runtime matrix + OSS/Cloud boundaryFixed stale content in
reference/file-formats.mdxcdql.yaml→dql.config.json(matches what v1.0.1 actually ships).dqlnbis clarified as the current notebook format, not legacyDeleted 27 legacy files under
docs/01-start-here/,02-core-workflows/,03-guides/,04-reference/,05-maintainers/— half-migrated, placeholder READMEsmigration-guides/— covered byguides/migrate.mdxexamples/— demo notebook moved toexamples/gallery/dql-language-spec.md,compatibility.md,faq.md,project-config.md,project-structure.md,v1-support-scope.md,publishing.md,repo-testing.md,data-sources.md— covered in Nextra or staleKept
docs/oss-readiness-checklist.md— internal maintainer docdocs/README.md— rewritten as a thin pointer to NextraVerification
pnpm --filter @duckcodeailabs/docs build— green, 28 pages prerenderednode apps/docs/scripts/link-check.mjs— 0 broken internal links_meta.jsonfor guides + reference)Net result
docs/folder: 29 files, mostly staleA new user hitting the repo now sees: clean README → one docs link → 5-minute quickstart. That was the goal.
🤖 Generated with Claude Code