Skip to content

chore(docs): collapsible examples, dated changelogs, bot sync token - #587

Merged
16bit-ykiko merged 3 commits into
mainfrom
chore/docs-cleanup
Aug 8, 2026
Merged

16bit-ykiko merged 3 commits into
mainfrom
chore/docs-cleanup

Conversation

@16bit-ykiko

Copy link
Copy Markdown
Member

What changed

  • Feature-doc examples now render collapsed. tools/feature_docs.ts wraps each generated example in <details><summary>Example</summary> (plain HTML rather than VitePress's ::: details, so the collapse also works on GitHub). All six fixture-generated feature docs regenerated; item titles, status boxes and descriptions stay visible, only the code folds.
  • Per-feature ## Changelog tables normalized. Every row now carries the real merge date (YYYY-MM-DD) and an inline PR link, recovered from git history; rows are reverse-chronological. — remains only in the PR column for changes predating the PR workflow. Also fixes hover's changelog date: feat(hover): port clangd hover implementation #452 merged 2026-06-12, not 2025-06.
  • Docs sync switched to the bot account. The deploy job in main.yml now uses the CLICE_DOCS secret (fine-grained PAT of clice-bot) instead of PUBLISH_DOCS, so sync PRs in the docs repo no longer impersonate the maintainer. Merging this PR touches docs/** and will itself exercise the new token end to end.
  • Removed docs/semantic-tokens-example.cpp, unreferenced since the tests refactor.

Tests

  • All four suites pass locally (unit 1174, integration 341, smoke 3, snap 395).
  • pixi run check-feature-docs, npm run check, pixi run format all clean.
  • VitePress build of the docs site verified locally with the regenerated pages; the rendered HTML contains the collapsed <details> blocks.

@coderabbitai

coderabbitai Bot commented Aug 8, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 982d122f-c2ea-48e8-8b91-526c67611042

📥 Commits

Reviewing files that changed from the base of the PR and between 602490f and 1515eb0.

📒 Files selected for processing (1)
  • docs/en/features/signature-help.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/en/features/signature-help.md

📝 Walkthrough

Walkthrough

The pull request adds collapsible sections around generated documentation examples, updates feature changelogs with dates and pull-request links, removes the semantic-token example fixture, and changes the documentation deployment secret.

Changes

Documentation presentation and metadata

Layer / File(s) Summary
Collapsible generated examples
tools/feature_docs.ts, docs/en/features/completion.md, docs/en/features/signature-help.md
Generated and feature examples now use collapsible HTML sections with an Example summary.
Symbol and folding example sections
docs/en/features/document-symbols.md, docs/en/features/folding-ranges.md
Document Symbols and Folding Ranges examples now use collapsible sections.
Hint and semantic-token example sections
docs/en/features/inlay-hints.md, docs/en/features/semantic-tokens.md
Inlay Hints and Semantic Tokens examples now use collapsible sections.
Documentation metadata and deployment configuration
.github/workflows/main.yml, docs/en/features/*.md
Changelog tables were reformatted or populated with dates and pull-request links. Documentation deployment now uses CLICE_DOCS.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation, changelog, and bot-token changes.
Description check ✅ Passed The description explains the changes and lists comprehensive test results; the optional related-issue section is correctly omitted.
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 chore/docs-cleanup

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

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b12b1e373b

ℹ️ 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".

Comment thread docs/en/features/lint.md Outdated
Comment thread docs/en/features/code-action.md Outdated
Comment thread docs/en/features/semantic-tokens.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 602490ff8e

ℹ️ 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".

Comment thread docs/en/features/signature-help.md Outdated
@16bit-ykiko
16bit-ykiko merged commit 604b5b1 into main Aug 8, 2026
34 checks passed
@16bit-ykiko
16bit-ykiko deleted the chore/docs-cleanup branch August 8, 2026 12:23
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