Skip to content

Update doc site#4

Merged
avidit merged 3 commits intomasterfrom
kca/update-docs
Apr 14, 2026
Merged

Update doc site#4
avidit merged 3 commits intomasterfrom
kca/update-docs

Conversation

@avidit
Copy link
Copy Markdown
Contributor

@avidit avidit commented Apr 13, 2026

Update readme for copilot, vscode and cursor and update the doc site

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the project documentation (README + static doc site) to reflect current setup flows for Claude Code, GitHub Copilot, VS Code, and Cursor, and refreshes the doc site UI/UX.

Changes:

  • Revamps the docs site layout/styling (wider layout, improved code blocks, responsive tweaks).
  • Adds a setup “tabs” UI for different tools (Claude Code, GitHub Copilot, VS Code, Cursor) plus improved search with result count + “no results” state.
  • Updates README setup instructions for GitHub Copilot, VS Code, and Cursor; bumps the Claude plugin version.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File Description
scripts/build_site.py Updates the HTML/CSS/JS template used to generate the docs site.
docs/index.html Regenerated/updated static site output to match the new template.
README.md Updates usage/setup guidance for Copilot, VS Code, and Cursor.
.claude-plugin/plugin.json Bumps plugin version.
Comments suppressed due to low confidence (2)

scripts/build_site.py:454

  • navigator.clipboard.writeText(...) is used without a .catch(...) handler. In environments where clipboard access is denied/unavailable, the button will fail silently; consider adding an error path (and optionally a fallback) and updating the accessible label/state when copy succeeds/fails.
document.querySelectorAll('.copy-btn').forEach(btn => {
  btn.addEventListener('click', () => {
    const text = btn.closest('.code-wrap').querySelector('.code-block').textContent.trim();
    navigator.clipboard.writeText(text).then(() => {
      btn.classList.add('copied');

docs/index.html:450

  • navigator.clipboard.writeText(...) is used without a .catch(...) handler. In environments where clipboard access is denied/unavailable, the button will fail silently; consider adding an error path (and optionally a fallback) and updating the accessible label/state when copy succeeds/fails.
document.querySelectorAll('.copy-btn').forEach(btn => {
  btn.addEventListener('click', () => {
    const text = btn.closest('.code-wrap').querySelector('.code-block').textContent.trim();
    navigator.clipboard.writeText(text).then(() => {

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread scripts/build_site.py
Comment on lines +97 to 99
.nav-logo img { width: 24px; height: 24px; flex-shrink: 0; }
.nav-logo span { overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }

Comment thread scripts/build_site.py
Comment on lines +383 to +387
<div class="tab-bar" id="setup-tabs">
<button class="tab-btn active" data-tab="claude"><i class="fa-solid fa-terminal"></i> Claude Code</button>
<button class="tab-btn" data-tab="copilot"><i class="fa-brands fa-github"></i> GitHub Copilot</button>
<button class="tab-btn" data-tab="vscode"><i class="fa-solid fa-code"></i> VS Code</button>
<button class="tab-btn" data-tab="cursor"><i class="fa-solid fa-arrow-pointer"></i> Cursor</button>
Comment thread scripts/build_site.py
Comment on lines +384 to +387
<button class="tab-btn active" data-tab="claude"><i class="fa-solid fa-terminal"></i> Claude Code</button>
<button class="tab-btn" data-tab="copilot"><i class="fa-brands fa-github"></i> GitHub Copilot</button>
<button class="tab-btn" data-tab="vscode"><i class="fa-solid fa-code"></i> VS Code</button>
<button class="tab-btn" data-tab="cursor"><i class="fa-solid fa-arrow-pointer"></i> Cursor</button>
Comment thread docs/index.html
Comment on lines +56 to +57
.nav-logo img { width: 24px; height: 24px; flex-shrink: 0; }
.nav-logo span { overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
Comment thread docs/index.html
Comment on lines +342 to +347
<div class="tab-bar" id="setup-tabs">
<button class="tab-btn active" data-tab="claude"><i class="fa-solid fa-terminal"></i> Claude Code</button>
<button class="tab-btn" data-tab="copilot"><i class="fa-brands fa-github"></i> GitHub Copilot</button>
<button class="tab-btn" data-tab="vscode"><i class="fa-solid fa-code"></i> VS Code</button>
<button class="tab-btn" data-tab="cursor"><i class="fa-solid fa-arrow-pointer"></i> Cursor</button>
</div>
Comment thread docs/index.html
Comment on lines +343 to +347
<button class="tab-btn active" data-tab="claude"><i class="fa-solid fa-terminal"></i> Claude Code</button>
<button class="tab-btn" data-tab="copilot"><i class="fa-brands fa-github"></i> GitHub Copilot</button>
<button class="tab-btn" data-tab="vscode"><i class="fa-solid fa-code"></i> VS Code</button>
<button class="tab-btn" data-tab="cursor"><i class="fa-solid fa-arrow-pointer"></i> Cursor</button>
</div>
@QilongTang
Copy link
Copy Markdown
Contributor

No change for Claude Code? LGTM then

@avidit avidit merged commit 1deb613 into master Apr 14, 2026
10 checks passed
@avidit avidit deleted the kca/update-docs branch April 14, 2026 16:36
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.

4 participants