Skip to content

Add package documentation, editor playgrounds, and GitHub Pages deployment - #3370

Draft
Dmitrii Shilov (bk201-) wants to merge 3 commits into
mainfrom
dev/dshilov/package-docs-pages
Draft

Dmitrii Shilov (bk201-) wants to merge 3 commits into
mainfrom
dev/dshilov/package-docs-pages

Conversation

@bk201-

@bk201- Dmitrii Shilov (bk201-) commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Add a standalone VitePress documentation site for the published NoSQL language service and schema analyzer, with API guides and commented Monaco, CodeMirror, and VS Code examples.
  • Add browser-only Monaco/CodeMirror playgrounds with editable documents, schema inference, diagnostics, and query samples that preserve the user's schema.
  • Add a dedicated documentation workflow: published-package unit tests, Pages-subpath browser tests, and GitHub Pages deployment only from main after successful checks.
  • Keep docs dependencies and lockfile separate from library workspaces, and use 80-column formatting inside docs.
image

Validation

  • Localization extraction, formatting, full lint, and all TypeScript build targets passed locally.
  • All 23 documentation unit tests and 5 Playwright browser tests passed against the Pages-path build.
  • GitHub Pages is configured to use GitHub Actions. The site deploys after merge to main at https://microsoft.github.io/vscode-cosmosdb/.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bk201-
Dmitrii Shilov (bk201-) requested a review from a team as a code owner September 25, 2026 15:44
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

🔬 NoSQL language-service integration

🧪 Result

  • NoSQL integration tests: ✅ success

📥 Artifacts (run)

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

✅ Build (Compile, Lint, Prettier, l10n, Package)

🧱 Step Results

  • Validate Version: ✅ success
  • Localization: ✅ success
  • Lint: ✅ success
  • Prettier: ✅ success
  • Compile (tsc): ✅ success
  • Package: ✅ success
  • External Skills (info): ✅ success

📥 Artifacts (run)

@github-code-quality

github-code-quality Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/vitest

The overall line coverage in commit 6f90993 in the dev/dshilov/package-... branch remains at 75%, unchanged from commit ff93f15 in the main branch.

Show a line coverage summary of the most impacted files.
File main ff93f15 dev/dshilov/package-... 6f90993 +/-
packages/docs/s.../scenarios.json 0% 0% 0%
packages/nosql-...schemaFields.ts 87% 87% 0%
packages/nosql-...guageService.ts 83% 85% +2%
packages/nosql-...ce/src/index.ts 94% 100% +6%
packages/docs/s...mples/schema.ts 0% 100% +100%
packages/docs/src/session.ts 0% 100% +100%

Updated September 29, 2026 11:40 UTC

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

🧪 Tests (Unit + Integration)

🧪 Results

  • Unit Tests (vitest): ✅ success
  • Integration Tests (extension host): ✅ success

📈 Coverage

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

🎭 E2E Tests (Playwright + VS Code)

🧪 Result

  • E2E Tests: ✅ success

📥 Artifacts (run)

Tip: the HTML report artifact contains a self-contained Playwright report.
Download the zip, extract, and open index.html — or run
npx playwright show-report <extracted-dir> for the interactive view.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread packages/docs/limitations.md Outdated

## 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"NoSQL SQL" => "NoSQL API" ?

@bk201-
Dmitrii Shilov (bk201-) marked this pull request as draft September 29, 2026 10:21
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.

3 participants