Skip to content

Port .devcontainer/docs/ to docs site#32

Merged
AnExiledDev merged 2 commits intomainfrom
port-devcontainer-docs-to-docs-site
Feb 27, 2026
Merged

Port .devcontainer/docs/ to docs site#32
AnExiledDev merged 2 commits intomainfrom
port-devcontainer-docs-to-docs-site

Conversation

@AnExiledDev
Copy link
Owner

@AnExiledDev AnExiledDev commented Feb 26, 2026

Summary

  • Ported 5 legacy docs from .devcontainer/docs/ into the Starlight documentation site at docs/
  • Created 3 new pages: Keybindings (Customization), Troubleshooting (Reference), Optional Features (Customization)
  • Merged unique content into 2 existing pages: setup variables into Environment Variables, .secrets auth into Configuration
  • Updated sidebar navigation in astro.config.mjs with all 3 new entries
  • Removed .devcontainer/docs/ — all content now lives in the docs site (zero codebase references to the old directory)

Content mapping

Legacy file Action
configuration-reference.md Merged unique sections (.env setup vars → environment.md, .secretsconfiguration.md)
keybindings.md New page → customization/keybindings.md
optional-features.md New page → customization/optional-features.md
plugins.md Fully superseded by existing docs site (14 plugin pages) — no merge needed
troubleshooting.md New page → reference/troubleshooting.md

Test plan

  • npm run build succeeds (40 pages built, was 37)
  • starlightLinksValidator passes — all internal links valid
  • New pages render in sidebar at correct positions
  • Verified .devcontainer/docs/ deleted with no broken references

Summary by CodeRabbit

  • Documentation
    • Migrated devcontainer docs into the main docs site and updated navigation
    • Added a Keybindings guide for VS Code terminal integration
    • Expanded Troubleshooting with clearer guidance and full reset procedures
    • Added Secrets File instructions to configuration docs
    • Clarified Optional Features with prerequisites and disablement tips
    • Published a consolidated Environment Variables (setup .env) reference

Merge 5 legacy reference docs from .devcontainer/docs/ into the
Starlight documentation site at docs/:

- New Keybindings page (Customization) — VS Code/Claude Code shortcut
  conflicts, resolution options, and full keybinding reference
- New Troubleshooting page (Reference) — 12+ problem/solution entries
  for build, auth, plugins, performance, and reset procedures
- New Optional Features page (Customization) — mcp-qdrant vector memory
  setup guide and feature disabling
- Merged setup variables (.env flags) into Environment Variables ref
- Merged .secrets authentication docs into Configuration page
- Updated sidebar navigation with 3 new entries
- Removed .devcontainer/docs/ (all content now in docs site)
@coderabbitai
Copy link

coderabbitai bot commented Feb 26, 2026

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 240adc2 and 868e586.

📒 Files selected for processing (1)
  • .devcontainer/CHANGELOG.md
 ________________________________________
< My other transformer is Optimus Prime. >
 ----------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

✏️ Tip: You can disable in-progress messages and the fortune message in your review settings.

📝 Walkthrough

Walkthrough

Documentation content migrated from .devcontainer/docs/ to the main docs site. Legacy documentation files deleted; corresponding pages added to the main documentation site with updated navigation configuration and expanded content covering keybindings, troubleshooting, optional features, and environment setup.

Changes

Cohort / File(s) Summary
Removed Legacy Documentation
.devcontainer/docs/configuration-reference.md, .devcontainer/docs/keybindings.md, .devcontainer/docs/plugins.md
Deleted three documentation files (configuration reference, keybindings, plugin system documentation) as part of content migration to main docs site.
Changelog Update
.devcontainer/CHANGELOG.md
Added Unreleased section documenting porting of .devcontainer/docs/ content to main docs site and removal of legacy documentation directory.
Navigation Configuration
docs/astro.config.mjs
Added three new sidebar navigation items: Keybindings and Optional Features under Customization, Troubleshooting under Reference.
New Documentation Pages
docs/src/content/docs/customization/keybindings.md
Created new comprehensive keybindings documentation covering VS Code terminal conflicts, resolution methods, JSON configuration examples, and command ID reference.
Updated Customization Docs
docs/src/content/docs/customization/configuration.md, docs/src/content/docs/customization/optional-features.md
Added Secrets File section documenting .secrets file format and token injection behavior; expanded Optional Features with prerequisites, disabling guidance, and related links.
Updated Reference Docs
docs/src/content/docs/reference/environment.md, docs/src/content/docs/reference/troubleshooting.md
Added Setup Variables (.env) documentation table in environment; restructured troubleshooting with formal front matter, expanded entries, new reset procedures, and related section with cross-references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Through docfiles we hopped, from old nests to new,
Keybindings, secrets, and troubleshoots too,
From .devcontainer paths we did clear,
Now the main docs shine bright and sincere! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and concisely describes the main change: porting legacy documentation from .devcontainer/docs/ to the main docs site.
Description check ✅ Passed The PR description comprehensively covers all template sections: clear summary of changes, related issue context, proper change type selection (Documentation), and completed checklist items including CHANGELOG and documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch port-devcontainer-docs-to-docs-site

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.devcontainer/CHANGELOG.md:
- Around line 14-20: Update the changelog line that currently reads "- **Ported
`.devcontainer/docs/` to docs site** — merged 5 legacy reference docs into the
Starlight documentation site:" to avoid saying all five were merged; change the
phrasing to something like "ported content from 5 legacy docs" (or "ported
content from 5 legacy reference docs, with one file superseded") so it
accurately reflects that plugins.md was superseded rather than merged, and
ensure the following bullet list remains unchanged except for any brief
parenthetical noting the superseded file.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 350b2b9 and 240adc2.

📒 Files selected for processing (10)
  • .devcontainer/CHANGELOG.md
  • .devcontainer/docs/configuration-reference.md
  • .devcontainer/docs/keybindings.md
  • .devcontainer/docs/plugins.md
  • docs/astro.config.mjs
  • docs/src/content/docs/customization/configuration.md
  • docs/src/content/docs/customization/keybindings.md
  • docs/src/content/docs/customization/optional-features.md
  • docs/src/content/docs/reference/environment.md
  • docs/src/content/docs/reference/troubleshooting.md
💤 Files with no reviewable changes (3)
  • .devcontainer/docs/keybindings.md
  • .devcontainer/docs/configuration-reference.md
  • .devcontainer/docs/plugins.md

One of the 5 legacy docs (plugins.md) was superseded rather than
merged, making "merged" inaccurate.
@AnExiledDev AnExiledDev merged commit 49ff9c7 into main Feb 27, 2026
5 of 6 checks passed
@AnExiledDev AnExiledDev deleted the port-devcontainer-docs-to-docs-site branch February 27, 2026 00:26
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