docs: v1.0 changelog and align guides with actual behavior

[16bit-ykiko]

Prepares the documentation side of the v1.0 release: a real feature changelog, and a pass over the guides and design docs to make them match what the server actually does today. English and Chinese are kept in lockstep; the Chinese changelog directory is new.

Changelog

• docs/{en,zh}/changelog/feature-changelog.md gains the v1.0.0 entry: everything user-visible since the v0.1.0-alpha series, grouped into architecture, compilation contexts, LSP surface, indexing, modules, caching, configuration, tooling API, editor extensions, and operability. Breaking changes and upgrade caveats (config file location, key rename, one-time cache/index rebuild, LLVM 21.1.8 baseline) are called out, and a "Known gaps" section keeps the claims honest (partial features, no code actions, clang-tidy unwired).
• The entry notes the release cadence: rolling betas first, final v1.0.0 after the trial period, no code freeze.

Configuration guide vs. reality

• Removed the phantom project.index_dir (the key does not exist; index artifacts live in the unified cache under cache_dir).
• Added the missing [tracker] section (poll intervals, 0 disables) and min/max_stateless_worker_count.
• Documented the real mechanics: discovery order (clice.toml, then .clice/config.toml), initializationOptions overriding the file with defaults applied after the merge, and the fact that config changes require a server restart (no hot reload).
• The Chinese page previously described unimplemented behavior as working (LRU by max_active_file, memory-based worker restarts); it now carries the same "not yet wired/enforced" caveats as the English page.
• docs/clice.toml no longer advertises ${version}/${llvm_version} substitution variables that never existed.

Editors guide

• The Vim snippet used a nonexistent clice server subcommand; it is clice serve.
• The compile-commands search description now matches the implementation (workspace root, then each immediate subdirectory — build/ is not special-cased).

Design docs

• design/overview.md: the src/server/ section described a layout that no longer exists (workspace/, MasterServer under service/). Rewritten to the actual six directories (protocol/, state/, compiler/, service/, transport/, worker/), including the invalidation engine and the stat-polling file tracker.
• design/incremental-parse.md: external changes are now discovered proactively by the file tracker (the two-layer check remains as the backstop), and two "known limitations" that have since been implemented (compile flags in the PCH cache key, shared cache metadata) are removed; the content-addressing description reflects the flag-aware key.

Out of scope, noted for follow-up

• editors/vscode/package.json declares a dead clice-client.trace.server key (the client id is clice) and a socket-mode port default that doesn't match the server's; these are extension-code fixes, not docs.
• design/multi-process.md uses pre-refactor terms for the master's state management in two conceptual sentences; judged non-misleading (no file paths involved).

Summary by CodeRabbit

• Documentation
  • Expanded the upcoming release notes with a fuller feature, change, fix, and known gaps overview.
  • Clarified configuration loading, cache storage, worker settings, file-change tracking, and editor setup guidance.
  • Updated design docs to better describe server layering, incremental parsing behavior, and cross-file navigation.
  • Refined supported variable examples and editor integration instructions.
  • Added a Chinese-language version of the feature changelog and aligned related guides.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e59c6019-b2d2-46eb-abad-15b243522e20

📥 Commits

Reviewing files that changed from the base of the PR and between 00f0e53 and e0405f4.

📒 Files selected for processing (11)

• docs/clice.toml
• docs/en/changelog/feature-changelog.md
• docs/en/design/incremental-parse.md
• docs/en/design/overview.md
• docs/en/guide/configuration.md
• docs/en/guide/editors.md
• docs/zh/changelog/feature-changelog.md
• docs/zh/design/incremental-parse.md
• docs/zh/design/overview.md
• docs/zh/guide/configuration.md
• docs/zh/guide/editors.md

💤 Files with no reviewable changes (1)

• docs/clice.toml

---

📝 Walkthrough

Walkthrough

Documentation-only update across English and Chinese docs: adds a v1.0.0 changelog (new Chinese translation included), revises design docs on invalidation/dirty-marking and server module layering (state/compiler/service/transport), updates configuration guide (worker counts, cache dir, tracker polling), corrects editors guide commands, and trims clice.toml comments.

Changes

Documentation updates

Layer / File(s)	Summary
v1.0.0 feature changelog docs/en/changelog/feature-changelog.md, docs/zh/changelog/feature-changelog.md	Adds a new v1.0.0 (upcoming) changelog section with Added/Changed/Fixed/Known gaps subsections in English, plus a full new Chinese translation of the changelog document.
Design docs: incremental-parse and server overview docs/en/design/incremental-parse.md, docs/zh/design/incremental-parse.md, docs/en/design/overview.md, docs/zh/design/overview.md	Revises dirty-marking/invalidation description (didChange vs stat-polling file tracker) and known limitations, and restructures src/server/ module layering into state/compiler/service/transport sections, for both languages.
Configuration guide updates docs/en/guide/configuration.md, docs/zh/guide/configuration.md	Documents config source/override order, adds min/max_stateless_worker_count, expands cache_dir scope, and introduces Tracker polling settings (cdb_poll_seconds, workspace_poll_seconds).
Editors guide and clice.toml cleanup docs/en/guide/editors.md, docs/zh/guide/editors.md, docs/clice.toml	Updates compile_commands.json discovery description, fixes Vim command from clice server to clice serve, and removes commented-out variable examples in clice.toml.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• clice-io/clice#468: Both PRs update docs/en/design/overview.md to redefine the src/server/ architecture layering and module responsibilities.
• clice-io/clice#472: Both PRs update the same design docs (incremental-parse.md, overview.md), including invalidation/dirty-marking and known-limitations wording.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main documentation work: the v1.0 changelog plus guide updates to match current behavior.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/v1-release-docs

Warning

Tools execution failed with the following error:

Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e0405f43d3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".