Skip to content

Commit 8d52cbd

Browse files
authored
Merge pull request #20 from costiash/dev/preformance-optim
feat: native plugin architecture with interactive courses and changelog reports (v1.1.0)
2 parents e9883be + 741efb6 commit 8d52cbd

36 files changed

Lines changed: 3864 additions & 2972 deletions

.claude-plugin/marketplace.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"name": "costiash"
55
},
66
"metadata": {
7-
"description": "Always up-to-date Claude documentation at your fingertips — 574+ docs covering Claude Code CLI, API, Agent SDK, and more"
7+
"description": "Always up-to-date Claude documentation at your fingertips. Content search, fuzzy matching, and auto-discovery — 574+ docs covering Claude Code CLI, API, Agent SDK, and more."
88
},
99
"plugins": [
1010
{

.gitignore

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,20 @@ claude-docs-helper.sh
9090
# Upstream reference repository (local development only)
9191
upstream/
9292

93+
# Source reference projects (local development only)
94+
codebase-to-course-main/
95+
96+
# Generated HTML artifacts (courses, changelogs — local only)
97+
*.html
98+
!index.html
99+
93100
# Archive folder (legacy/orphaned scripts)
94101
archive/
95102

96103
# Plan documents (local development only, contain local paths)
97104
docs/plans/
98105

99106
# Skill evaluation workspace (development artifacts)
100-
plugin/skills/claude-docs-workspace/
101107
plugin/skills/claude-docs/evals/
102108

103109
# ============================================================================
@@ -153,5 +159,5 @@ Pipfile.lock
153159
!docs/
154160
!scripts/
155161
!tests/
156-
!enhancements/
157162
!.github/
163+
autoresearch-results.tsv

CHANGELOG.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,62 @@ All notable changes to the enhanced edition of claude-code-docs will be document
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.1.0] - 2026-03-28
9+
10+
### Added
11+
- **`claude-docs-course/` interactive course skill**: Generates self-contained HTML courses on any Claude documentation topic
12+
- 4-phase pipeline: Topic Discovery → Curriculum Design → Build (module by module) → Review & Open
13+
- **Obsidian & Amber design theme**: Dark obsidian backgrounds, warm amber accents, Instrument Serif + Outfit typography, grain textures, glass-morphism effects
14+
- `references/design-system.md` — Complete CSS design tokens for the Obsidian & Amber theme
15+
- `references/interactive-elements.md` — 18 interactive element patterns including Protocol Conversations, code translations, quizzes, data flow animations, glossary tooltips
16+
- `examples/course-from-docs.md` — Worked example for hooks course generation
17+
- Courses saved to `~/.claude-code-docs/courses/<topic-slug>.html`
18+
- **`claude-docs-changelog/` report skill**: Generates HTML changelog reports of recent documentation changes
19+
- Discovers changes via git history, categorizes by doc type, summarizes key updates
20+
- Each entry includes a "Create Course" button that copies `/docs --course <topic>` to clipboard
21+
- Obsidian & Amber themed to match courses
22+
- `examples/changelog-report.md` — Worked example
23+
- **Post-response course prompt**: After every docs response, an emphasized prompt invites users to generate an interactive course on the topic
24+
- **`/docs --course <topic>`** route: Direct course generation via the `/docs` command
25+
- **`/docs --report`** route: Generate HTML changelog with configurable timeframe (default: 7 days)
26+
27+
### Changed
28+
- **`/docs` command** expanded: Now routes to 4 skills (search, validate, course, changelog) + inline git log
29+
- **README.md**: Added "Interactive Courses" and "Changelog Reports" sections with usage examples
30+
- **CLAUDE.md**: Updated plugin structure, routing table, and key files for new skills
31+
- **CONTRIBUTING.md**: Updated for 4-skill architecture
32+
- **`.gitignore`**: Added `codebase-to-course-main/` and generated HTML exclusions
33+
34+
## [1.0.0] - 2026-03-28
35+
36+
### Breaking Changes
37+
- **Plugin is now the primary (and only recommended) install path**`install.sh` is now a migration wrapper that guides users to plugin install
38+
- **Legacy helper scripts no longer user-facing**`claude-docs-helper.sh` and the Python lookup module are now CI-only; plugin skills handle all user-facing search
39+
40+
### Added
41+
- **`claude-docs/` search skill**: Enhanced search with 4-tier strategy (direct lookup, scoped search, content search, fuzzy matching)
42+
- `scripts/content-search.sh` — Full-text keyword search using `.search_index.json` or grep fallback
43+
- `scripts/fuzzy-search.sh` — Token-based fuzzy filename matching
44+
- `examples/` — 3 worked examples (direct lookup, semantic search, cross-context disambiguation)
45+
- **`claude-docs-validate/` health check skill**: Documentation freshness and URL reachability checks
46+
- `scripts/validate-paths.sh` — Parallel HTTP HEAD checks with `--quick` mode
47+
- `examples/` — Validation workflow example
48+
- **Zero Python dependency for users** — All plugin features use shell scripts only; Python is CI-only
49+
50+
### Changed
51+
- **`/docs` command** rewritten as lean router (~40 lines) delegating to skills
52+
- **`install.sh`** rewritten as migration wrapper (~100 lines) routing to plugin install
53+
- **`uninstall.sh`** simplified to plugin uninstall instructions
54+
- **CLAUDE.md** streamlined — removed ~350 lines of search strategy (now lives in skill SKILL.md)
55+
- **README.md** updated — plugin-first, script install moved to "Legacy" section
56+
- **UNINSTALL.md** simplified to plugin-only primary path
57+
- **CONTRIBUTING.md** updated for plugin-first development workflow
58+
59+
### Removed
60+
- `plugin/skills/claude-docs-workspace/` — Stale Phase 2 eval artifacts (was gitignored, not in repo)
61+
- User-facing Python search (replaced by shell scripts in plugin skills)
62+
- Legacy install.sh functionality (779 lines → 100 lines)
63+
864
## [0.6.0] - 2026-02-28
965

1066
### Added

0 commit comments

Comments
 (0)