Repository navigation
Docs site: switch to Just the Docs with OS dark mode - #420
Merged
Merged
Conversation
…-update # Conflicts: # .github/workflows/deploy-documentation-preview.yml
Contributor
✅ CI passed: standard tier (ready PR)Commit
Full run: add the Code quality
Build sizeNo page, activation, VSIX or other bundle size changed by 5% or 50 KiB or more against Artifacts: VSIX | Bundle-reports-38887904126 | L1-manifest-report-38887904126 All graphs (exact bytes)
Packaged bytes. Shared chunks count in every graph that loads them, so rows do not add up. Updated in place on every run. |
Move THEME_CUSTOMIZATION.md out of the published docs root into a new docs-site feature entry (README, design, iteration 01). Refresh the guide against current GitHub Pages (github-pages v232, Actions deploy, previews still alpha) and record open gaps (nav key mismatch, ai-and-plans published). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Exclude ai-and-plans, blog-posts and internal top-level docs from the GitHub Pages build. No published or in-product link points to them. Remove the stale PR-preview warning from _config.yml and update the docs-site feature entry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace the experimental Minima setup with Just the Docs (remote_theme, v0.12.0): sidebar for the user manual and release notes, search, breadcrumbs, and light/dark that follows the OS. Navigation lives in _config.yml defaults, so no content file changes. Light Microsoft styling (Segoe UI, #0067b8, semibold headings). Interim until the user manual moves to learn.microsoft.com. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Group the user manual into Connecting to Databases, Data Management, Querying and AI Features (four new category pages), nested as in the landing page's table of contents. No existing file moves, so all URLs stay valid. Replace the 'Back to ...' header on every user manual and release notes page with front matter (title, parent, nav_order); breadcrumbs take over. Navigation moves out of _config.yml. Release notes sort newest first via nav_order = major*1000 + minor*10. Update the writing-release-notes skill and strip front matter when posting release notes as a discussion. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Use the documentdb.io favicon. Show the DocumentDB icon next to the sidebar title, swapping the light and dark variants with the OS theme (copies of resources/documentdb icons with a viewBox so they scale). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a sticky right-side panel listing the article's h2/h3 sections with the current one highlighted (assets/js/page-toc.js), shown on wide screens. Put the landing page's three links on one line. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ing levels The panel gets a first 'Introduction' entry that returns to the top, and tracks the current section on scroll. The overview page had extra H1s (Features, Table of Contents), so the panel skipped them; they are now H2, with User Manual promoted in place of 'Table of Contents'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a dark-framed variant rendered with the documentation-screenshots skill and serve it through <picture> with prefers-color-scheme. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Render _dark companions with the approved framing settings (light re-renders match the published images pixel for pixel) and wrap each image in a <picture> element with a prefers-color-scheme: dark source. 0.11.0 reuses the 1.0 Cluster Dashboard dark frame; the 0.4.0 logo gets a recolored dark variant. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace the user manual copy-and-paste illustrations with Fluent-style diagrams drawn natively for each theme, and fix their alt text. The 0.7 release notes now reuse the 1.0 copy-and-paste screenshot. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The theme kept the 16px body line box around 12px code, which left gaps between box-drawing lines. Size the <pre> like its code and use a 1.25 line height. Also align one row of the Azure VMs filter diagram. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The theme styled h4 as small uppercase labels, so step headings such as 'Step 1: Select an Account' were hard to spot. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
preview.ps1 builds and serves docs/ the way GitHub Pages does, keeps the Gemfile, lock file and _site outside the repository, and fixes --source path casing so docs/_sass is not silently dropped on Windows. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
page-toc.js runs in the browser on GitHub Pages, so give docs/assets/js the browser globals instead of Node's, and add the license header. This fixes the Static checks failure on #420. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Builds the site the way GitHub Pages does, uploads it as an artifact and keeps one docs-preview comment on same-repository PRs with the download link and the changed pages. Read-only, deploys nothing, and catches a broken Pages build before merge instead of after. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The GitHub Pages plugins load rake, which Bundler on the Linux runner does not provide. Also soften the build-failure comment: not every failure means GitHub Pages would fail. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The preview artifact had no theme layout. Also fail the build when pages come out without the layout, instead of uploading a broken preview. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The downloaded artifact did not render like the live site, and matching the GitHub Pages build is not worth the extra moving parts. Local previews stay with the previewing-docs-site skill. Keeps rake in its Gemfile, which Bundler needs on Linux and macOS. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sandeep S Nair (sandeepsnairms)
approved these changes
Oct 16, 2026
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
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.
What changed
The documentation site at https://microsoft.github.io/vscode-documentdb/ gets a new theme, cleaner navigation, and a dark mode that follows the OS.
Site and navigation
remote_theme, v0.12.0): sidebar, search, breadcrumbs, and Microsoft styling (Segoe UI,#0067b8, semibold headings).user-manual/andrelease-notes/. Everything else indocs/(plans, blog drafts, data-flow notes) is excluded.Dark mode
_darkvariant, swapped with<picture>andprefers-color-scheme. They are rendered from the same framing settings as the light images (the light re-renders match the published images pixel for pixel).Readability fixes
####headings (for example "Step 1: Select an Account") were tiny uppercase labels; they are now body-sized and semibold.Tooling
previewing-docs-siteskill:scripts/preview.ps1serves the site locally with live reload, keeps all build output outside the repository, and fixes the Windows path-casing issue that silently drops the custom styles.docs/assets/jsas browser code.writing-release-notesskill andCONTRIBUTING.mdupdated for the release notes front matter.Why
The site is an interim home until the user manual moves to learn.microsoft.com, so the goal is a site that looks right and costs little to maintain, without rewriting content into a site-specific format.
Rejected: PR previews in CI. The old
gh-pagespreview workflow was removed inc8ad1900; bringing it back would need write access togh-pages, cleanup, and would leak unreleased pages into the live sidebar and search. A downloadable artifact build was also tried in this PR and dropped: matching the GitHub Pages build closely enough was not worth the extra moving parts. Reviewers preview locally with thepreviewing-docs-siteskill.Scope
Not in this PR:
Validation
github-pagesgem (the same build GitHub Pages uses), in light and dark mode.Links
docs/ai-and-plans/features/docs-site/(README.md,iterations/02-just-the-docs.md)