User guide
Writes a user guide for an app by crawling it, taking screenshots and generating the text.
partData26 operationsid userguide
How it sits
A part does one thing, and any other part can call it. The counts and the links below are from the platform's spec and the other services' own descriptions.
| Operations | 26 GET 16 · POST 7 · DELETE 1 · PATCH 1 · PUT 1 |
| Resources | 9 |
| Leaned on by | no other service names it |
| Leans on | none named |
| In recipes | none yet |
What it can do
26 operations in 9 resources, as the spec declares them. Each row is one call; paths are relative to the part.
modules
| Method | Path | Does |
|---|---|---|
| DELETE | /api/modules/{module_id} | Delete a module |
| GET | /api/modules/{module_id} | Get module details |
| PATCH | /api/modules/{module_id} | Update module configuration |
| GET | /api/modules/{module_id}/artifacts | List all module artifacts |
| POST | /api/modules/{module_id}/generate | Start generation (INIT → GENERATING) |
| GET | /api/modules/{module_id}/markdown | List module markdown files |
| POST | /api/modules/{module_id}/publish | Publish module (VALIDATING → PUBLISHED) |
| POST | /api/modules/{module_id}/regenerate | Regenerate module (VALIDATING → GENERATING) |
| POST | /api/modules/{module_id}/reset | Reset module (ANY → INIT) |
| GET | /api/modules/{module_id}/screenshots | List module screenshots |
10 operations
apps
| Method | Path | Does |
|---|---|---|
| GET | /api/apps | List all registered apps |
| POST | /api/apps | Register a new app |
| GET | /api/apps/{app_id} | Get app by ID |
| GET | /api/apps/{app_id}/versions | List app versions |
| POST | /api/apps/{app_id}/versions | Create a new version |
| PUT | /api/apps/{app_id}/versions/{version_id}/activate | Activate a version |
6 operations
health
| Method | Path | Does |
|---|---|---|
| GET | /health | Basic health check |
| GET | /health/detailed | Detailed health check |
2 operations
platform
| Method | Path | Does |
|---|---|---|
| GET | /api/platform/catalog | Raw platform catalog |
| GET | /platform | Hierarchical platform browse |
2 operations
versions
| Method | Path | Does |
|---|---|---|
| GET | /api/versions/{version_id}/modules | List modules for a version |
| POST | /api/versions/{version_id}/modules | Create a new module |
2 operations
directory
| Method | Path | Does |
|---|---|---|
| GET | /api/directory | Services Directory payload |
1 operation
prime
| Method | Path | Does |
|---|---|---|
| GET | /prime | Prime application caches |
1 operation
screenshots
| Method | Path | Does |
|---|---|---|
| GET | /screenshots | Browse all screenshots |
1 operation
status
| Method | Path | Does |
|---|---|---|
| GET | /status | Service status overview |
1 operation
All the partsDataThe platform's own id for this service is cbuserguide.
forge-catalog.json, generated Oct 30, 2026