Skip to content

feat: docs overhaul — VitePress 2, Agent Skills quick start, homepage redesign, and LLM-friendly markdown export#363

Merged
clavery merged 1 commit intomainfrom
feature/vitepress-upgrade
Apr 20, 2026
Merged

feat: docs overhaul — VitePress 2, Agent Skills quick start, homepage redesign, and LLM-friendly markdown export#363
clavery merged 1 commit intomainfrom
feature/vitepress-upgrade

Conversation

@clavery
Copy link
Copy Markdown
Collaborator

@clavery clavery commented Apr 20, 2026

Summary

  • VitePress upgrade: 1.6.4 → 2.0.0-alpha.17 (Vite 7, Shiki 3)
  • Package manager & IDE icons: vitepress-plugin-group-icons with custom icons for npm, npx, pnpm, yarn, Homebrew, Agentforce Vibes, Claude Code, Copilot, Codex, and B2C CLI
  • Edit link + timestamps: "Suggest changes to this page" links and "Last updated" timestamps on all hand-authored pages; suppressed on generated /api/* pages via typedoc-plugin-frontmatter
  • "View as Markdown" / "Copy for LLM" buttons: on all doc pages — aside panel on desktop, inline above content on mobile. Raw .md sources copied to build output via buildEnd hook
  • Enhanced local search: detailed view, fuzzy matching, prefix search, title/text boosting
  • Homepage redesign:
    • New hero tagline aligned with Salesforce platform strategy messaging
    • Hero collage showing CLI, Agentforce Vibes, and Claude Code in use
    • Custom HomeLayout.vue with hero → install sections → features → packages ordering
    • Install Agent Skills code-group with marketplace tabs for Agentforce Vibes, Claude Code, Copilot (VS Code), Copilot CLI, Codex, and B2C CLI
  • Agent Skills page rewrite: consolidated plugins table, Quick Start with IDE-specific marketplace install tabs, streamlined install instructions
  • Introduction page rewrite: CLI-first messaging, agent skills positioned second
  • SDK API docs: added operations/debug entry point, updated package structure diagram (28 → 29 modules), marked telemetry module as @internal

…UX improvements

- Upgrade VitePress from 1.6.4 to 2.0.0-alpha.17
- Add vitepress-plugin-group-icons for package manager and IDE icons in code tabs
- Add typedoc-plugin-frontmatter to suppress editLink/lastUpdated on generated API pages
- Add editLink ("Suggest changes to this page"), lastUpdated timestamps, and enhanced local search config
- Add "View as Markdown" / "Copy for LLM" buttons on all doc pages (aside on desktop, inline on mobile)
- Custom HomeLayout with hero → install sections → features → packages ordering
- New hero collage showing CLI, Agentforce Vibes, and Claude Code
- Rewrite homepage hero text and features to align with Salesforce platform strategy
- Rewrite agent-skills page: consolidated plugins table, Quick Start with marketplace install tabs for Agentforce Vibes, Claude Code, Copilot, Codex, and B2C CLI
- Rewrite introduction page with CLI-first, skills-second messaging
- Update SDK API docs: add operations/debug entry point, update package structure diagram, mark telemetry module as @internal
- Copy source .md files to build output via buildEnd hook for raw markdown access
@github-actions github-actions Bot added the needs-3pl-review PR introduces net-new third-party dependencies and needs discussion label Apr 20, 2026
@clavery clavery changed the title feat: upgrade docs to VitePress 2.0.0-alpha.17 feat: docs overhaul — VitePress 2, Agent Skills quick start, homepage redesign, and LLM-friendly markdown export Apr 20, 2026
@clavery clavery added 3pl-approved Maintainer approved net-new third-party dependency additions and removed needs-3pl-review PR introduces net-new third-party dependencies and needs discussion labels Apr 20, 2026
@clavery clavery marked this pull request as ready for review April 20, 2026 17:42
@clavery clavery merged commit e79e275 into main Apr 20, 2026
6 of 7 checks passed
@clavery clavery deleted the feature/vitepress-upgrade branch April 20, 2026 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3pl-approved Maintainer approved net-new third-party dependency additions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant