Skip to content

Commit 6a8b69a

Browse files
committed
docs: polish marketplace copy and onboarding
1 parent f6fcf95 commit 6a8b69a

File tree

8 files changed

+418
-174
lines changed

8 files changed

+418
-174
lines changed

.claude-plugin/marketplace.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
22
"$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
33
"name": "code-sensei",
4-
"version": "1.0.0",
5-
"description": "Learn to code while you vibecode. Free, open-source AI mentor by Dojo Coding — contextual explanations, quizzes, and belt progression built into every Claude Code session.",
4+
"version": "1.1.0",
5+
"description": "In-context coding tutor for Claude Code. Learn from your real project with explanations, quizzes, diagnostics, and belt-based progression — locally and privately.",
66
"owner": {
77
"name": "Dojo Coding",
88
"email": "team@dojocoding.io"
99
},
1010
"plugins": [
1111
{
1212
"name": "code-sensei",
13-
"description": "AI coding mentor that teaches programming while you vibecode. Contextual explanations, micro-quizzes, and a martial arts belt progression system — from White Belt to Black Belt. Adapts to your skill level and professional background.",
14-
"version": "1.0.0",
13+
"description": "In-context coding tutor for Claude Code. Explains what AI just built, quizzes you on your own project, and tracks progress locally with a martial arts belt progression system.",
14+
"version": "1.1.0",
1515
"author": {
1616
"name": "Dojo Coding",
1717
"email": "team@dojocoding.io"
@@ -34,7 +34,10 @@
3434
"beginner",
3535
"tutorial",
3636
"gamification",
37-
"code-learning"
37+
"code-learning",
38+
"coding-tutor",
39+
"developer-education",
40+
"privacy-first"
3841
]
3942
}
4043
]

.claude-plugin/plugin.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "code-sensei",
3-
"version": "1.0.0",
4-
"description": "Learn to code while you vibecode. Free, open-source AI mentor by Dojo Coding — contextual explanations, quizzes, and belt progression built into every Claude Code session.",
3+
"version": "1.1.0",
4+
"description": "In-context coding tutor for Claude Code. Learn from your real project with explanations, quizzes, diagnostics, and belt-based progression — locally and privately.",
55
"author": {
66
"name": "Dojo Coding",
77
"url": "https://dojocoding.io"
@@ -25,6 +25,9 @@
2525
"tutorial",
2626
"gamification",
2727
"code-learning",
28+
"coding-tutor",
29+
"developer-education",
30+
"privacy-first",
2831
"code-sensei",
2932
"dojo-coding"
3033
]

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
All notable changes to CodeSensei will be documented in this file.
4+
5+
## 1.1.0
6+
7+
- Added `/code-sensei:doctor` for setup verification and local storage inspection
8+
- Added deterministic profile import script with preview/apply workflow
9+
- Hardened command logging with secret redaction
10+
- Added retention caps for local session logs
11+
- Improved marketplace-facing README and privacy documentation
12+
- Tightened concept tracking alignment and launch validation
13+
14+
## 1.0.0
15+
16+
- Initial public release of CodeSensei
17+
- Hook-based contextual teaching for Claude Code
18+
- Belt progression, quiz bank, and persistent local profile

CONTRIBUTING.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,20 @@ claude
5555
# Install
5656
/plugin install code-sensei
5757

58-
# Test your changes
58+
# Verify local setup
59+
/code-sensei:doctor
60+
61+
# Test key commands
62+
/code-sensei:progress
5963
/code-sensei:explain
6064
/code-sensei:quiz
61-
/code-sensei:progress
65+
/code-sensei:export
66+
```
67+
68+
### Validate Before You Open a PR
69+
```bash
70+
shellcheck -S error scripts/*.sh scripts/lib/*.sh
71+
bash tests/test-hooks.sh
6272
```
6373

6474
### What We Need Help With
@@ -70,9 +80,10 @@ claude
7080

7181
### PR Guidelines
7282
1. Keep it focused — one feature or fix per PR
73-
2. Test with Claude Code locally before submitting
74-
3. Update quiz-bank.json if adding new concepts
75-
4. Follow the existing tone: encouraging, simple, analogy-first
83+
2. Run the validation commands above before submitting
84+
3. Test with Claude Code locally before submitting
85+
4. Update `quiz-bank.json` if adding new concepts
86+
5. Follow the existing tone: encouraging, simple, analogy-first
7687

7788
## Code of Conduct
7889

PRIVACY.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# CodeSensei Privacy & Local Storage
2+
3+
CodeSensei is designed to be local-first.
4+
5+
This document explains what the plugin stores on disk, what it does not do, and how retention works.
6+
7+
## What CodeSensei stores locally
8+
9+
By default, CodeSensei writes data under:
10+
11+
```text
12+
~/.code-sensei/
13+
```
14+
15+
### `profile.json`
16+
Your persistent learning profile, including:
17+
- belt
18+
- XP
19+
- streak data
20+
- quiz counters
21+
- quiz history
22+
- concepts seen
23+
- concepts mastered
24+
- preferences
25+
- achievement metadata
26+
27+
### `profile.json.backup`
28+
A backup of the previous profile created before import overwrites it.
29+
30+
### `session-commands.jsonl`
31+
A recent local history of shell commands used for contextual teaching.
32+
33+
Stored fields:
34+
- timestamp
35+
- redacted/truncated command string
36+
- concept classification
37+
38+
Important:
39+
- CodeSensei redacts common secret patterns before logging
40+
- Commands are truncated before storage
41+
- This file is capped to the most recent 1000 lines
42+
43+
### `session-changes.jsonl`
44+
A recent local history of file-change events.
45+
46+
Stored fields:
47+
- timestamp
48+
- tool name
49+
- file path
50+
- extension
51+
- detected tech label
52+
- tracked concept identifier
53+
54+
This file is capped to the most recent 1000 lines.
55+
56+
### `sessions.log`
57+
A compact session start/stop log used for streaks and session summaries.
58+
59+
This file is capped to the most recent 500 lines.
60+
61+
### `pending-lessons/`
62+
Structured teaching moments queued during the active session.
63+
64+
This queue is cleared at session end after archival.
65+
66+
### `lessons-archive/`
67+
Archived teaching moments from past sessions.
68+
69+
Retention:
70+
- keeps the last 30 daily archive files
71+
72+
### `error.log`
73+
Local plugin script errors for troubleshooting.
74+
75+
## What CodeSensei does not do
76+
77+
The shell scripts in this repository do not:
78+
- upload your code
79+
- send telemetry
80+
- send your profile to Dojo Coding
81+
- call external tracking APIs
82+
83+
## Redaction behavior
84+
85+
CodeSensei attempts to redact common sensitive patterns before writing commands to local logs, including values that look like:
86+
- `*_TOKEN`
87+
- `*_SECRET`
88+
- `*_PASSWORD`
89+
- `*_API_KEY`
90+
- `Authorization: Bearer ...`
91+
- credential-bearing URLs like `https://user:pass@example.com`
92+
93+
This redaction is heuristic, not a cryptographic guarantee.
94+
95+
If you run especially sensitive commands and want zero retention, you should clear `~/.code-sensei/` afterwards.
96+
97+
## How to inspect your local footprint
98+
99+
Run:
100+
101+
```bash
102+
/code-sensei:doctor
103+
```
104+
105+
That command reports:
106+
- setup health
107+
- profile status
108+
- storage paths
109+
- pending lesson count
110+
- next-step suggestions
111+
112+
## How to reset everything
113+
114+
Delete the local directory:
115+
116+
```bash
117+
rm -rf ~/.code-sensei
118+
```
119+
120+
That removes your local profile, logs, backups, pending lessons, and archives.

0 commit comments

Comments
 (0)