Skip to content

Commit 72f4232

Browse files
dougborgclaude
andcommitted
docs: rewrite user-facing docs for StatusPro, strip Katana-era remnants
Follow-up sweep after the initial fork commit. The bulk rename caught identifiers but left many docs/examples describing Katana's manufacturing ERP domain. This commit rewrites them around StatusPro's actual surface (7 endpoints, Orders + Statuses). User-facing rewrites: - README.md: drops the "Manufacturing ERP" framing; adds a correct "API Coverage" table listing the real 9 endpoints + conventions (Bearer auth, {data, meta} envelope, page/per_page pagination, per-endpoint rate limits). - statuspro_mcp_server/README.md: documents the 9 tools and two-step confirm pattern. - packages/statuspro-client/README.md: describes /orders + /statuses flows, switches package to @statuspro/client. - statuspro_public_api_client/docs/{guide,cookbook}.md: rewritten with StatusPro-focused examples. - packages/statuspro-client/docs/{guide,cookbook}.md: same. - statuspro_mcp_server/docs/{index,README,examples}.md: StatusPro tool flows. - docs/CHANGELOG.md + statuspro_public_api_client/docs/CHANGELOG.md: reset to a v0.1.0 baseline. - CLAUDE.md: updated Known Pitfalls for StatusPro (per_page vs limit, mixed list envelopes, 7 endpoints). - AGENT_WORKFLOW.md: replaced Katana example scenarios. - mkdocs.yml: retitled description. - examples/README.md: points at the per-package cookbooks; dropped references to deleted Katana example scripts. Deletions (Katana-only): - statuspro_mcp_server/docs/{architecture,implementation-plan}.md - statuspro_mcp_server/docs/adr/0010-statuspro-mcp-server.md - statuspro_public_api_client/docs/adr/0007-domain-helper-classes.md - statuspro_mcp_server/src/statuspro_mcp/tools/{prefab_ui,tool_result_utils,decorators}.py (Katana-domain Prefab UI builders + cache-aware decorators; not used by the new simple tool implementations). - scripts/{extract_all_statuspro_docs,create_mcp_issues,create_mcp_issues_from_json,analyze_api_documentation,validate_schema_consistency,test_mcp_resources}.py (Katana-specific tooling). Code changes: - statuspro_public_api_client/api_wrapper/_registry.py: resource registry reduced from 47 Katana resources to 2 StatusPro resources (orders, statuses). Only GET /orders, GET /orders/{id}, and GET /statuses fit the CRUD shape; mutation endpoints are exposed via domain helpers. - statuspro_public_api_client/domain/base.py: example docstring rewritten around Order instead of StatusProVariant. - statuspro_mcp_server/src/statuspro_mcp/__init__.py: package docstring no longer claims Manufacturing ERP tooling. - scripts/regenerate_client.py: dropped Katana-specific receive_purchase_order.py post-processing step. - Test dummy tool names updated from check_inventory to update_order_status. Validation: `uv run poe check` passes (192 tests + lint + typecheck + yamllint + mdformat). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 4507485 commit 72f4232

47 files changed

Lines changed: 1233 additions & 15197 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENT_WORKFLOW.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ Each agent has domain-specific knowledge and follows project patterns.
7676
For straightforward tasks, use a specialist agent directly:
7777

7878
```
79-
@agent-dev implement the create_sales_order tool following the purchase order pattern
79+
@agent-dev implement the bulk_update_order_status tool following the update_order_status pattern
8080
```
8181

8282
```
83-
@agent-test write comprehensive tests for the inventory helper functions
83+
@agent-test write comprehensive tests for the orders helper functions
8484
```
8585

8686
```
@@ -198,7 +198,7 @@ Here's how multiple agents work together on a feature:
198198
1. **Planning Phase**
199199

200200
```
201-
@agent-plan break down "Add sales order support" into implementation tasks
201+
@agent-plan break down "Add richer comment filtering" into implementation tasks
202202
→ Creates detailed plan with phases
203203
→ Identifies dependencies
204204
→ Creates individual issues
@@ -207,7 +207,7 @@ Here's how multiple agents work together on a feature:
207207
1. **Implementation Phase**
208208

209209
```
210-
@agent-dev implement sales_orders.py following purchase order pattern
210+
@agent-dev implement a new tool for filtering by date range, following the list_orders pattern
211211
→ Implements tool with proper patterns
212212
→ Adds error handling and logging
213213
→ Creates PR with changes
@@ -216,7 +216,7 @@ Here's how multiple agents work together on a feature:
216216
1. **Testing Phase**
217217

218218
```
219-
@agent-test write comprehensive tests for sales_orders tool
219+
@agent-test write comprehensive tests for new tool
220220
→ Writes unit tests for all functions
221221
→ Tests success and error paths
222222
→ Verifies 90%+ coverage
@@ -225,7 +225,7 @@ Here's how multiple agents work together on a feature:
225225
1. **Documentation Phase**
226226

227227
```
228-
@agent-docs document the sales_orders tool
228+
@agent-docs document the new tool
229229
→ Adds docstrings
230230
→ Updates README
231231
→ Adds cookbook example
@@ -234,7 +234,7 @@ Here's how multiple agents work together on a feature:
234234
1. **Review Phase**
235235

236236
```
237-
@agent-review review PR #123 for sales orders
237+
@agent-review review PR #123 for new tool
238238
→ Checks pattern adherence
239239
→ Verifies test coverage
240240
→ Validates documentation
@@ -385,8 +385,8 @@ git commit -m "feat: your commit message"
385385
**Examples:**
386386

387387
```bash
388-
git commit -m "feat(mcp): add inventory resources"
389-
git commit -m "fix(client): handle null values in variants"
388+
git commit -m "feat(mcp): add status-history resource"
389+
git commit -m "fix(client): handle null status on orders"
390390
git commit -m "docs: update AGENT_WORKFLOW.md"
391391
git commit -m "test: add coverage for edge cases"
392392
```
@@ -746,8 +746,8 @@ ______________________________________________________________________
746746
**Solution:**
747747

748748
- Follow conventional commits format
749-
- Be specific: "fix(client): handle null variant names"
750-
- Include context: "refactor: extract helper for variant display names"
749+
- Be specific: "fix(client): handle empty viable-statuses response"
750+
- Include context: "refactor: extract helper for order status mapping"
751751

752752
______________________________________________________________________
753753

CLAUDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,10 @@ at the httpx transport layer — every endpoint gets it automatically.
139139

140140
## File Rules
141141

142-
| Category | Files | Action |
143-
| ------------- | -------------------------------------------- | --------------- |
144-
| **EDITABLE** | `statuspro_client.py`, tests/, scripts/, docs/ | Can modify |
145-
| **GENERATED** | `api/**/*.py`, `models/**/*.py`, `client.py` | **DO NOT EDIT** |
142+
| Category | Files | Action |
143+
| ------------- | ---------------------------------------------- | --------------- |
144+
| **EDITABLE** | `statuspro_client.py`, tests/, scripts/, docs/ | Can modify |
145+
| **GENERATED** | `api/**/*.py`, `models/**/*.py`, `client.py` | **DO NOT EDIT** |
146146

147147
Regenerate client: `uv run poe regenerate-client` (2+ min)
148148

@@ -260,7 +260,7 @@ tasks:
260260
| Commit standards | [.github/agents/guides/shared/COMMIT_STANDARDS.md](.github/agents/guides/shared/COMMIT_STANDARDS.md) |
261261
| File organization | [.github/agents/guides/shared/FILE_ORGANIZATION.md](.github/agents/guides/shared/FILE_ORGANIZATION.md) |
262262
| Architecture | [.github/agents/guides/shared/ARCHITECTURE_QUICK_REF.md](.github/agents/guides/shared/ARCHITECTURE_QUICK_REF.md) |
263-
| Client guide | [statuspro_public_api_client/docs/guide.md](statuspro_public_api_client/docs/guide.md) |
264-
| MCP docs | [statuspro_mcp_server/docs/README.md](statuspro_mcp_server/docs/README.md) |
265-
| TypeScript client | [packages/statuspro-client/README.md](packages/statuspro-client/README.md) |
263+
| Client guide | [statuspro_public_api_client/docs/guide.md](statuspro_public_api_client/docs/guide.md) |
264+
| MCP docs | [statuspro_mcp_server/docs/README.md](statuspro_mcp_server/docs/README.md) |
265+
| TypeScript client | [packages/statuspro-client/README.md](packages/statuspro-client/README.md) |
266266
| ADRs | [docs/adr/README.md](docs/adr/README.md) |

0 commit comments

Comments
 (0)