Skip to content

Commit 7348923

Browse files
committed
docs: clarify platform support and command usage
1 parent 2b5508d commit 7348923

File tree

4 files changed

+43
-2
lines changed

4 files changed

+43
-2
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ git clone https://github.com/DojoCodingLabs/code-sensei.git
4444
cd code-sensei
4545
```
4646

47+
Supported development environments:
48+
- macOS
49+
- Linux
50+
- Windows via WSL
51+
4752
### Testing Locally
4853
```bash
4954
# Open Claude Code

PRIVACY.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ CodeSensei is designed to be local-first.
44

55
This document explains what the plugin stores on disk, what it does not do, and how retention works.
66

7+
Platform note:
8+
- CodeSensei currently targets macOS and Linux shells.
9+
- On Windows, use WSL for the most reliable behavior.
10+
711
## What CodeSensei stores locally
812

913
By default, CodeSensei writes data under:

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,18 @@ Instead of forcing people to stop building and go study in a separate environmen
5757

5858
`jq` is required for profile tracking, imports, quizzes, and diagnostics.
5959

60+
### Supported platforms
61+
62+
- ✅ macOS
63+
- ✅ Linux
64+
- ⚠️ Windows via WSL recommended
65+
66+
CodeSensei is a Unix-shell plugin today. Its runtime depends on `bash`, `jq`, and standard Unix tools, so WSL is the safest path on Windows.
67+
6068
### Install from marketplace
6169

70+
Inside Claude Code:
71+
6272
```bash
6373
/plugin marketplace add DojoCodingLabs/code-sensei
6474
/plugin install code-sensei@code-sensei
@@ -76,9 +86,11 @@ After install:
7686

7787
### Update
7888

89+
Inside Claude Code:
90+
7991
```bash
80-
claude plugin marketplace update DojoCodingLabs/code-sensei
81-
claude plugin update code-sensei@code-sensei
92+
/plugin marketplace update DojoCodingLabs/code-sensei
93+
/plugin update code-sensei@code-sensei
8294
```
8395

8496
Restart your Claude Code session after updating so hooks reload cleanly.

docs/plans/2026-03-19-marketplace-readiness.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,23 @@
7777
- [ ] Hook regression tests pass locally
7878
- [ ] CI runs critical hook tests
7979
- [ ] Repo is clean and pushed to `main`
80+
81+
---
82+
83+
## Follow-up production hardening (reviewer notes)
84+
85+
These items were identified in the final marketplace review and should be addressed as part of ongoing production readiness:
86+
87+
1. **Supported platform clarity**
88+
- Make README/listing docs explicit that CodeSensei supports macOS and Linux.
89+
- Clarify that Windows users should use WSL unless native Windows support is added later.
90+
91+
2. **Command-surface consistency**
92+
- Use one consistent “inside Claude Code” command style in README examples for install/update flows.
93+
94+
3. **Expanded behavioral test coverage**
95+
- Add regression coverage for `scripts/session-start.sh`.
96+
- Add regression coverage for `scripts/export-profile.sh`.
97+
98+
4. **macOS CI smoke coverage**
99+
- Add a lightweight `macos-latest` GitHub Actions job that installs `jq`, runs key shell smoke/behavior tests, and validates the Unix-shell support claim.

0 commit comments

Comments
 (0)