Skip to content

refactor(website): move docs/ and playground/ into website/#304

Open
kunlinglio wants to merge 3 commits into
pascal-lab:masterfrom
kunlinglio:website
Open

refactor(website): move docs/ and playground/ into website/#304
kunlinglio wants to merge 3 commits into
pascal-lab:masterfrom
kunlinglio:website

Conversation

@kunlinglio

Copy link
Copy Markdown

This pr moved docs/ into website/site workspace and playground/ into a dedicate website/playground workspace.

The old docs/ directory is pretty confused since the convention of docs indicates documents of the repo, especially development documents. Moving it to website/site makes its purpose clearer. Move it to website make it sounds more specificated. Since the playground/ is only used under the website, so moving it also makes sense.

As both site and playground are still separate npm package, this PR adds a npm workspace under website/ to manage them together.

Copilot AI review requested due to automatic review settings July 20, 2026 14:48
@kunlinglio kunlinglio changed the title refactor(Website): move docs/ and playground/ into website/ refactor(website): move docs/ and playground/ into website/ Jul 20, 2026

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.

Pull request overview

This PR restructures the documentation website by moving the former docs/ site into a dedicated website/site workspace and relocating the browser playground into website/playground, managed together via an npm workspaces root at website/. It also updates CI/deploy workflows and internal scripts to use the new paths.

Changes:

  • Introduced a website/ npm-workspaces layout with site/ (Astro/Starlight docs) and playground/ (browser lab + embeddable widget).
  • Migrated/added documentation content under website/site/src/content/docs (ZH + EN) and added site components/utilities to support docs rendering.
  • Updated build/release scripts and GitHub Actions workflows to build/preview/deploy from the new website/ structure.

Reviewed changes

Copilot reviewed 21 out of 262 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/site/tsconfig.json Adds site TS config for Astro/Starlight project.
website/site/src/starlightRouteData.ts Route middleware to customize sidebar/pagination behavior.
website/site/src/data/vscodeSettings.ts Updates VS Code settings table data source paths for new layout.
website/site/src/data/userConfigSettings.ts Updates user-config settings data source paths for new layout.
website/site/src/content/docs/user-guide/zed-installation.mdx Adds Zed installation guide (ZH).
website/site/src/content/docs/user-guide/vscode-installation.mdx Adds VS Code installation guide (ZH).
website/site/src/content/docs/user-guide/project-configuration-effects.mdx Adds config behavior comparison doc (ZH).
website/site/src/content/docs/user-guide/installation.mdx Adds installation landing page (ZH).
website/site/src/content/docs/user-guide/index.mdx Adds user guide index (ZH).
website/site/src/content/docs/user-guide/features/syntax-highlighting.mdx Adds feature doc: syntax highlighting (ZH).
website/site/src/content/docs/user-guide/features/signature-help.mdx Adds feature doc: signature help (ZH).
website/site/src/content/docs/user-guide/features/semantic-highlighting.mdx Adds feature doc: semantic highlighting (ZH).
website/site/src/content/docs/user-guide/features/selection-range.mdx Adds feature doc: selection range (ZH).
website/site/src/content/docs/user-guide/features/rename.mdx Adds feature doc: rename (ZH).
website/site/src/content/docs/user-guide/features/references.mdx Adds feature doc: references (ZH).
website/site/src/content/docs/user-guide/features/navigation.mdx Adds feature doc: navigation (ZH).
website/site/src/content/docs/user-guide/features/index.mdx Adds features index (ZH).
website/site/src/content/docs/user-guide/features/hover.mdx Adds feature doc: hover (ZH).
website/site/src/content/docs/user-guide/features/formatting.mdx Adds feature doc: formatting (ZH).
website/site/src/content/docs/user-guide/features/folding.mdx Adds feature doc: folding (ZH).
website/site/src/content/docs/user-guide/features/document-symbols.mdx Adds feature doc: document symbols (ZH).
website/site/src/content/docs/user-guide/features/diagnostics.mdx Adds feature doc: diagnostics (ZH).
website/site/src/content/docs/user-guide/features/completion.mdx Adds feature doc: completion (ZH).
website/site/src/content/docs/user-guide/features/annotations.mdx Adds feature doc: annotations (ZH).
website/site/src/content/docs/user-guide/commands-status-logs.mdx Adds VS Code status/commands/logs doc (ZH).
website/site/src/content/docs/playground.mdx Adds Playground landing page (ZH).
website/site/src/content/docs/index.mdx Adds site homepage content (ZH).
website/site/src/content/docs/en/user-guide/zed-installation.mdx Adds Zed installation guide (EN).
website/site/src/content/docs/en/user-guide/vscode-installation.mdx Adds VS Code installation guide (EN).
website/site/src/content/docs/en/user-guide/project-configuration-effects.mdx Adds config behavior comparison doc (EN).
website/site/src/content/docs/en/user-guide/installation.mdx Adds installation landing page (EN).
website/site/src/content/docs/en/user-guide/index.mdx Adds user guide index (EN).
website/site/src/content/docs/en/user-guide/features/syntax-highlighting.mdx Adds feature doc: syntax highlighting (EN).
website/site/src/content/docs/en/user-guide/features/signature-help.mdx Adds feature doc: signature help (EN).
website/site/src/content/docs/en/user-guide/features/semantic-highlighting.mdx Adds feature doc: semantic highlighting (EN).
website/site/src/content/docs/en/user-guide/features/selection-range.mdx Adds feature doc: selection range (EN).
website/site/src/content/docs/en/user-guide/features/rename.mdx Adds feature doc: rename (EN).
website/site/src/content/docs/en/user-guide/features/references.mdx Adds feature doc: references (EN).
website/site/src/content/docs/en/user-guide/features/quick-fixes.mdx Adds feature doc: quick fixes/refactoring (EN).
website/site/src/content/docs/en/user-guide/features/navigation.mdx Adds feature doc: navigation (EN).
website/site/src/content/docs/en/user-guide/features/index.mdx Adds features index (EN).
website/site/src/content/docs/en/user-guide/features/hover.mdx Adds feature doc: hover (EN).
website/site/src/content/docs/en/user-guide/features/formatting.mdx Adds feature doc: formatting (EN).
website/site/src/content/docs/en/user-guide/features/folding.mdx Adds feature doc: folding (EN).
website/site/src/content/docs/en/user-guide/features/document-symbols.mdx Adds feature doc: document symbols (EN).
website/site/src/content/docs/en/user-guide/features/diagnostics.mdx Adds feature doc: diagnostics (EN).
website/site/src/content/docs/en/user-guide/features/completion.mdx Adds feature doc: completion (EN).
website/site/src/content/docs/en/user-guide/features/annotations.mdx Adds feature doc: annotations (EN).
website/site/src/content/docs/en/user-guide/commands-status-logs.mdx Adds VS Code status/commands/logs doc (EN).
website/site/src/content/docs/en/playground.mdx Adds Playground landing page (EN).
website/site/src/content/docs/en/index.mdx Adds site homepage content (EN).
website/site/src/content/docs/en/changelog/v1-2-3/index.mdx Adds changelog page 1.2.3 (EN).
website/site/src/content/docs/en/changelog/v1-2-2/index.mdx Adds changelog page 1.2.2 (EN).
website/site/src/content/docs/en/changelog/v1-2-1/index.mdx Adds changelog page 1.2.1 (EN).
website/site/src/content/docs/en/changelog/v1-1-0/index.mdx Adds changelog page 1.1.0 (EN).
website/site/src/content/docs/en/changelog/index.mdx Adds changelog index (EN).
website/site/src/content/docs/en/advanced-guide/index.mdx Adds advanced guide index (EN).
website/site/src/content/docs/en/advanced-guide/advanced-installation.md Updates advanced install doc path references (EN).
website/site/src/content/docs/en/404.md Adds localized 404 page (EN).
website/site/src/content/docs/changelog/v1-2-3/index.mdx Adds changelog page 1.2.3 (ZH).
website/site/src/content/docs/changelog/v1-2-2/index.mdx Adds changelog page 1.2.2 (ZH).
website/site/src/content/docs/changelog/v1-2-1/index.mdx Adds changelog page 1.2.1 (ZH).
website/site/src/content/docs/changelog/index.mdx Adds changelog index (ZH).
website/site/src/content/docs/advanced-guide/index.mdx Adds advanced guide index (ZH).
website/site/src/content/docs/advanced-guide/advanced-installation.md Updates advanced install doc path references (ZH).
website/site/src/content/docs/404.md Adds localized 404 page (ZH).
website/site/src/content.config.ts Adds Starlight content collection configuration.
website/site/src/components/VscodeSettingsTable.astro Adds component to render VS Code settings tables.
website/site/src/components/ThinLinkCard.astro Adds reusable thin link card component.
website/site/src/components/StatusBarPreview.astro Adds VS Code status bar preview component.
website/site/src/components/SiteFooter.astro Adds custom site footer.
website/site/src/components/Sidebar.astro Adds custom sidebar with site nav links.
website/site/src/components/HomepageCta.astro Adds homepage CTA component.
website/site/src/components/HomepageComparisonSection.astro Adds homepage comparison section wrapper.
website/site/src/components/Codicon.astro Adds codicon rendering helper for docs.
website/site/src/assets/vide-logo-reveal-light.svg Adds animated logo asset (light).
website/site/src/assets/vide-logo-reveal-dark.svg Adds animated logo asset (dark).
website/site/src/assets/vide-logo-light.svg Adds logo asset (light).
website/site/src/assets/vide-logo-dark.svg Adds logo asset (dark).
website/site/scripts/release-body-from-changelog.mjs Updates changelog-to-release script paths for new layout.
website/site/scripts/create-404-alias.mjs Adds postbuild 404 alias generator script.
website/site/scripts/copy-schemas.mjs Updates schema-copy script to new repo root relative paths.
website/site/public/pascal.svg Adds PASCAL logo asset.
website/site/public/favicon.svg Adds site favicon asset.
website/site/package.json Adds docs site package definition and scripts.
website/site/astro.config.mjs Updates edit links and config for new site location.
website/site/.gitignore Ignores generated schemas and lab assets under site public/.
website/playground/vite.embed.config.ts Adds Vite config for building embeddable lab bundle.
website/playground/tsconfig.json Adds strict TS config for playground package.
website/playground/src/workers/lsp-protocol.ts Adds shared LSP protocol types/interfaces for worker.
website/playground/src/types.ts Adds shared type definitions for lab/scenarios.
website/playground/src/scenarios/syntax-error/vide.toml Adds scenario config for syntax-error demo.
website/playground/src/scenarios/syntax-error/scenario.json Adds syntax-error scenario metadata.
website/playground/src/scenarios/syntax-error/rtl/broken.sv Adds syntax-error scenario RTL file.
website/playground/src/scenarios/signature-inlay/vide.toml Adds signature-inlay scenario config.
website/playground/src/scenarios/signature-inlay/scenario.json Adds signature-inlay scenario metadata.
website/playground/src/scenarios/signature-inlay/rtl/packet_path.sv Adds signature-inlay RTL file (path).
website/playground/src/scenarios/signature-inlay/rtl/packet_fifo.sv Adds signature-inlay RTL file (fifo).
website/playground/src/scenarios/rename/scenario.json Adds rename scenario metadata.
website/playground/src/scenarios/rename/rtl/rename_playground.sv Adds rename scenario RTL file.
website/playground/src/scenarios/navigation/scenario.json Adds navigation scenario metadata.
website/playground/src/scenarios/navigation/rtl/pipeline_top.sv Adds navigation scenario RTL file (top).
website/playground/src/scenarios/navigation/rtl/pipeline_stage.sv Adds navigation scenario RTL file (stage).
website/playground/src/scenarios/macro-guard/vide.toml Adds macro-guard scenario config.
website/playground/src/scenarios/macro-guard/scenario.json Adds macro-guard scenario metadata.
website/playground/src/scenarios/macro-guard/rtl/feature_gate.sv Adds macro-guard scenario RTL file.
website/playground/src/scenarios/macro-guard/include/feature_defs.svh Adds macro-guard include file.
website/playground/src/scenarios/counter/vide.toml Adds counter scenario config.
website/playground/src/scenarios/counter/tb/counter_tb.sv Adds counter scenario TB file.
website/playground/src/scenarios/counter/scenario.json Adds counter scenario metadata.
website/playground/src/scenarios/counter/rtl/counter.sv Adds counter scenario RTL file.
website/playground/src/scenarios/basics/scenario.json Adds basics scenario metadata.
website/playground/src/scenarios/basics/rtl/control_fsm.sv Adds basics scenario RTL file.
website/playground/src/scenarios/bad-port/vide.toml Adds bad-port scenario config.
website/playground/src/scenarios/bad-port/scenario.json Adds bad-port scenario metadata.
website/playground/src/scenarios/bad-port/rtl/top.sv Adds bad-port scenario RTL top.
website/playground/src/scenarios/bad-port/rtl/child.sv Adds bad-port scenario RTL child.
website/playground/src/scenarios.ts Adds scenario loader/registry for lab UI.
website/playground/src/pages/index.astro Adds playground shell page.
website/playground/src/pages/embed-example.astro Adds embed demo page.
website/playground/src/pages/docs-embed.astro Adds docs-embed entry page.
website/playground/src/locale/zh-hans.ts Adds zh-Hans language pack import.
website/playground/src/lab/workspace.ts Adds workspace path/URI helpers and file classification.
website/playground/src/lab/workspace-mutations.ts Adds create/rename/delete mutations for editable workspace.
website/playground/src/lab/vscode-platform.ts Adds Monaco VS Code platform bootstrap.
website/playground/src/lab/monaco-setup.ts Updates VS Code grammar/config asset paths for new layout.
website/playground/src/lab/monaco-lsp.ts Adds LSP-to-Monaco diagnostics/marker conversion helpers.
website/playground/src/lab/editor-workspace.ts Adds model lifecycle + active-file management.
website/playground/src/lab/diagnostics.ts Adds diagnostics controller with debouncing/generation control.
website/playground/src/components/VideLabEmbedExample.astro Adds standalone embed example page shell.
website/playground/src/components/VideLab.astro Adds lab mount component with configurable props.
website/playground/src/components/icons.ts Adds icon rendering helper using lucide nodes.
website/playground/scripts/script-utils.mjs Updates script roots for new website/playground nesting.
website/playground/scripts/copy-docs-wasm-assets.mjs Adds compatibility wrapper for wasm asset copy.
website/playground/scripts/copy-docs-assets.mjs Updates docs asset copy destinations for new site location.
website/playground/README.md Adds playground package README.
website/playground/package.json Adds playground package definition and scripts.
website/playground/astro.config.mjs Adds playground Astro config (site/base normalization).
website/playground/.gitignore Adds playground ignore rules (wasm outputs, target/, etc).
website/playground/.gitattributes Adds EOL normalization rules for scripts.
website/package.json Adds workspace root package with setup/build scripts.
website/.gitignore Adds website-level ignore for node_modules.
README.zh-CN.md Updates logo asset URLs to new site path.
README.md Updates logo asset URLs to new site path.
editors/vscode/scripts/copy-web-assets.ts Updates VS Code web asset copy path to new wasm output location.
.github/workflows/docs-preview.yml Updates docs preview workflow to build from website/.
.github/workflows/deploy-docs.yml Updates deployment workflow paths to website/site/dist.
.github/workflows/ci.yml Updates CI caching/build steps for wasm + website workspaces.
.github/workflows/build-artifacts.yml Updates artifact build workflow for new wasm build location.
.github/ci-modules.yml Updates CI module paths to use website/** workspace files.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@hongjr03

Copy link
Copy Markdown
Member

LGTM. I'll merge it once all checks have passed.

@kunlinglio
kunlinglio requested a review from hongjr03 July 21, 2026 13:22
@kunlinglio

Copy link
Copy Markdown
Author

@hongjr03
Hey, I tried to fix the CI failure by adding npm install before npm ci. It's a bit workaround but we have nothing to do with it since that failure is caused by the npm upstream issue (npm/cli#4828).

I also found and fixed a few remaining CI paths that still referred to the old docs/ / playground/ directory.

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