Repository navigation
Add package documentation, editor playgrounds, and GitHub Pages deployment - #3370
Dmitrii Shilov (bk201-) wants to merge 3 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
🔬 NoSQL language-service integration🧪 Result
📥 Artifacts (run)
|
✅ Build (Compile, Lint, Prettier, l10n, Package)🧱 Step Results
📥 Artifacts (run) |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/vitestThe overall line coverage in commit 6f90993 in the Show a line coverage summary of the most impacted files.
Updated |
🧪 Tests (Unit + Integration)🧪 Results
📈 Coverage |
🎭 E2E Tests (Playwright + VS Code)🧪 Result
📥 Artifacts (run)
|
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Three moderate review issues and one dependency cleanup issue remain unresolved.
Review effort: Lite
Findings: None
What changed in this PR
Adds a standalone VitePress documentation site with editor playgrounds, integration samples, tests, and GitHub Pages deployment.
Changes:
- Adds API guides and Monaco, CodeMirror, and VS Code examples.
- Adds schema-aware browser playgrounds with diagnostics.
- Adds isolated documentation dependencies, CI tests, and Pages deployment.
| File | Summary |
|---|---|
tsconfig.eslint.json |
Includes documentation sources. |
test/docs/vitest.config.ts |
Configures published-package unit tests. Moderate (1 vote): tests are also included by the root Vitest configuration. |
test/docs/playwright.config.ts |
Configures documentation browser tests. |
test/docs/playground.spec.ts |
Tests playground navigation, editors, schemas, and diagnostics. |
packages/README.md |
Documents package and documentation workflows. |
packages/docs/vscode.md |
Adds VS Code integration guidance. |
packages/docs/tsconfig.json |
Configures documentation type-checking. |
packages/docs/src/session.ts |
Manages playground service state. |
packages/docs/src/session.test.ts |
Tests session and inference behavior. |
packages/docs/src/editor.ts |
Defines editor integration interfaces. |
packages/docs/schema-analyzer.md |
Documents schema analyzer APIs. |
packages/docs/samples/vscode.ts |
Provides a VS Code sample. |
packages/docs/samples/schema.ts |
Provides schema inference samples. |
packages/docs/samples/scenarios.json |
Defines playground scenarios. |
packages/docs/samples/monaco.ts |
Provides a Monaco integration sample. |
packages/docs/samples/codemirror.ts |
Provides a CodeMirror integration sample. |
packages/docs/samples.md |
Documents executable samples. |
packages/docs/playground.md |
Documents the interactive playground. |
packages/docs/package.json |
Defines documentation dependencies and scripts. Nit (1 vote): removes or justifies the unused direct codemirror dependency. |
packages/docs/package-lock.json |
Locks documentation dependencies. |
packages/docs/monaco.md |
Documents Monaco integration. |
packages/docs/limitations.md |
Documents usage and safety limitations. |
packages/docs/language-service.md |
Documents language-service APIs. |
packages/docs/index.md |
Adds the documentation landing page. |
packages/docs/getting-started.md |
Adds installation and quick-start guidance. |
packages/docs/components/Playground.vue |
Implements the playground UI. Moderate (1 vote): synchronously recalculates diagnostics on every keystroke. |
packages/docs/codemirror.md |
Documents CodeMirror integration. |
packages/docs/.vitepress/theme/ThemeToggle.vue |
Adds theme switching. |
packages/docs/.vitepress/theme/style.css |
Defines site styling. Moderate (1 vote): dark-theme muted text lacks sufficient contrast. |
packages/docs/.vitepress/theme/index.ts |
Registers the custom theme. |
packages/docs/.vitepress/config.ts |
Configures VitePress and the Pages base path. |
packages/docs/.gitignore |
Ignores generated documentation output. |
package.json |
Adds documentation scripts and workspace configuration. |
package-lock.json |
Updates workspace metadata. |
eslint.config.mjs |
Ignores generated documentation output. |
.oxlintrc.jsonc |
Ignores generated documentation output. |
.oxfmtrc.json |
Adds documentation formatting rules. |
.github/workflows/docs.yml |
Adds documentation testing and Pages deployment. |
.github/workflows/build.yml |
Installs documentation dependencies in CI. |
Files not reviewed (1)
- packages/docs/package-lock.json: Generated file
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## Parsing is not execution | ||
|
|
||
| The language service analyzes Cosmos DB for NoSQL SQL. It is not a database SDK, SQL execution engine, query planner, or general-purpose SQL dialect parser. |
…oss documentation and code
Summary
Validation