split README into topic-based guides - #16
Merged
Merged
Conversation
Luca (lukka)
marked this pull request as ready for review
September 16, 2026 00:32
Member
Author
Glen Chung (@kuchungmsft) thanks, fixed in 53c1088 |
Glen Chung (kuchungmsft)
approved these changes
Sep 16, 2026
Luca (lukka)
requested review from
Ben McMorran (benmcmorran)
and
a balanced review from Copilot
September 17, 2026 00:17
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation-only reorganization is coherent, preserves compatibility anchors, and has valid local links.
Review effort: Balanced
Findings: None
What changed in this PR
Reorganizes detailed documentation into focused guides while keeping the README concise and preserving legacy anchors.
Changes:
- Adds a documentation index with topic-based guides and references.
- Documents WCI controls and standalone source checking.
- Retains quick-start, feedback, and legal information in the README.
| File | Description |
|---|---|
README.md |
Streamlines overview and links to detailed guides. |
docs/index.md |
Adds the central documentation index. |
docs/installation.md |
Covers installation and platform requirements. |
docs/authentication.md |
Covers authentication and enterprise login. |
docs/compile-commands.md |
Documents compilation database generation. |
docs/configuration.md |
Documents server configuration and discovery. |
docs/indexing.md |
Covers indexing controls and WCI. |
docs/troubleshooting.md |
Consolidates diagnostics and feedback guidance. |
docs/command-line-options.md |
Documents CLI options and check mode. |
docs/lsp-features.md |
Lists supported LSP capabilities. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Ben McMorran (benmcmorran)
approved these changes
Sep 17, 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.
This pull request reorganizes the Microsoft C++ Language Server documentation into topic-based guides and reference pages under
docs/. The root README stays focused on the project overview, full inline quick start, essential links, and legal notices.Documentation changes
--check=<file>and--check-compile-commands=<path>, including standalone usage, prerequisites, compilation-database discovery, and check-mode exit codes.Manual validation
This PR changes documentation only; it does not change language-server or plugin runtime behavior.