Skip to content

Commit 0c18a16

Browse files
LessUpCopilot
andcommitted
docs(phase3): add clangd/.clangd detail and audit .vscode/ absence
- AGENTS.md: expand LSP bullet to reference .clangd config file and CMAKE_EXPORT_COMPILE_COMMANDS=ON in CMakePresets.json - AGENTS.md: add 'Editor integration' section documenting that .vscode/ is gitignored and absent; prefer .clangd / .editorconfig / presets - CLAUDE.md: expand Language server line to reference .clangd config and compile_commands.json export AI workflow docs (docs/en/contributing/ai-workflow.md and zh equivalent) already exist with clangd documented — no changes needed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d807ea3 commit 0c18a16

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,14 @@ ctest --preset=ubsan
8585
- **AGENTS.md**: shared repo guidance for Codex-style agents and terminal copilots.
8686
- **CLAUDE.md**: Claude Code specific guidance.
8787
- **`.github/copilot-instructions.md`**: GitHub Copilot repository instructions.
88-
- **LSP**: prefer `clangd` backed by `compile_commands.json`.
88+
- **LSP**: prefer `clangd` backed by `compile_commands.json`. The `.clangd` config at the repo root points `CompilationDatabase` to `build/debug`; all CMake presets export `compile_commands.json` via `CMAKE_EXPORT_COMPILE_COMMANDS=ON`.
8989
- **Review model**: use `/review` before merge or after major cleanup phases.
9090
- **Autopilot strategy**: prefer a longer single-session implementation flow over `/fleet` unless the task is truly parallelizable.
9191

92+
## Editor integration
93+
94+
The `.vscode/` directory is **gitignored** and does not exist in the repository. Workspace settings live only in local developer environments. Do not commit `.vscode/` content — use the `.clangd`, `.editorconfig`, and `CMakePresets.json` files for machine-readable project conventions instead.
95+
9296
## Things to avoid reintroducing
9397

9498
- HonKit / GitBook-era configuration

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Help finish this repository cleanly. Prioritize hardening, consistency, and remo
2121

2222
- Docs stack: **VitePress**, published via GitHub Pages
2323
- Build system: **CMake + presets**
24-
- Language server: **clangd**
24+
- Language server: **clangd** — configured via `.clangd` at repo root (`CompilationDatabase: build/debug`); all CMake presets export `compile_commands.json` via `CMAKE_EXPORT_COMPILE_COMMANDS=ON`
2525
- Primary maintenance target: **Linux**
2626
- Repo posture: **archive-ready / low-frequency maintenance**
2727

0 commit comments

Comments
 (0)