Skip to content

docs: pure-OSS markdown, drop Nextra site#5

Merged
KKranthi6881 merged 5 commits into
mainfrom
claude/pure-oss-docs
Apr 17, 2026
Merged

docs: pure-OSS markdown, drop Nextra site#5
KKranthi6881 merged 5 commits into
mainfrom
claude/pure-oss-docs

Conversation

@KKranthi6881

Copy link
Copy Markdown
Collaborator

Summary

  • DQL is now a pure GitHub-native OSS repo — no hosted docs site. All docs render directly on github.com.
  • Port 27 Nextra MDX pages to plain markdown under docs/ (quickstart, concepts, install, guides, reference, architecture, contribute).
  • Delete apps/docs/ (Nextra app) and .github/workflows/deploy-docs.yml; scrub every docs.duckcode.ai reference across READMEs, CLI banner, Homebrew template, plugin-api JSDoc, and CI comments.
  • docs/README.md is a numbered reading-order index; root README.md links into ./docs/ via relative paths.

Test plan

  • grep -r docs.duckcode.ai returns nothing outside .git/
  • ls apps/docs fails (directory deleted)
  • docs/README.md renders correctly on github.com with working links to 01-quickstart / 02-concepts / 03-install and every guide/reference/architecture/contribute page
  • Root README.md links into ./docs/ work on github.com
  • pnpm -r build still succeeds (no broken workspace references)

🤖 Generated with Claude Code

KKranthi6881 and others added 5 commits April 17, 2026 16:43
DQL is a GitHub-native open-source project — no hosted docs site. All
documentation now lives as plain markdown in docs/, renders directly on
github.com, and is linked from the root README and per-package READMEs.

- Port 27 MDX pages to docs/{01-quickstart,02-concepts,03-install,guides,reference,architecture,contribute}
- Delete apps/docs/ (Nextra app) and .github/workflows/deploy-docs.yml
- Strip docs.duckcode.ai references from CLI banner, package READMEs,
  Homebrew formula template, plugin-api JSDoc, and CI comments
- Write docs/README.md as a numbered reading-order index
- Rewrite root README.md to link into ./docs/ via relative paths

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- docs job pointed at deleted apps/docs/scripts/link-check.mjs → replace
  with scripts/check-doc-links.mjs that validates every relative markdown
  link under docs/ and root README.md
- format-check built only dql-cli (pnpm -F) which skipped deps and broke
  on missing apps/dql-notebook/dist → switch to full pnpm build (turbo
  handles dependency order)
- apps/desktop tauri build required icons/ (not in repo) and raced with
  dql-ui writes during concurrent turbo tasks → make desktop's default
  build a no-op; tauri compile now lives only under release-desktop.yml
  (build:tauri script preserved for local/manual use)
- declare dql-notebook-app as a desktop workspace dep so its build is
  ordered before desktop even after the no-op

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
formatSQLQuery() stripped all leading whitespace via .trim() on the raw
SQL, which erased the common leading indent of the first line. Every
fmt pass then prepended the block-level indent on top, so each run
added ~2 spaces and the file drifted forever. `dql fmt --check`
therefore always failed on any block with a multi-line query.

Strip only leading newlines and trailing whitespace, compute the min
leading whitespace across non-empty lines, and subtract it before
re-indenting. Now `fmt` is a fixed point.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Two follow-ups to the previous fmt fix:

1. formatCall() was joining every SQL line with `,` as if each were a
   separate positional arg, mangling multi-line SELECTs in dashboards.
   Treat the whole SQL query as one chunk; add the inter-arg comma only
   after its last line.

2. formatSQLQuery() still drifted when the first SQL line shared a row
   with the opening `(` (e.g. `chart.bar(SELECT ...`). Its leading
   indent is lost by the parser, so including it in the dedent baseline
   made minLeading = 0 and every pass re-added the block indent. Use
   tail lines for the dedent baseline; fall back to the first line only
   when there are no others.

Verified idempotent on both template files.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@KKranthi6881 KKranthi6881 merged commit 553fc1a into main Apr 17, 2026
8 checks passed
@KKranthi6881 KKranthi6881 deleted the claude/pure-oss-docs branch April 17, 2026 22:10
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>
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