Task
This app needs documentation to appear on developers.whilesmart.com under the Apps section.
The site fetches docs from a docs.json manifest plus markdown files in a docs/ folder at runtime.
Action
Template docs.json
{
"": "https://raw.githubusercontent.com/whilesmart/docs-kit/main/schema/docs.schema.json",
"name": "Project Name",
"description": "Short description",
"icon": "lucide-icon-name",
"category": { "language": "go" },
"sidebar": [
{ "title": "Installation", "path": "docs/installation.md" },
{ "title": "Usage", "path": "docs/usage.md" }
]
}
Note: For app, category.framework is optional (omit for CLI/tools).
Acceptance
docs.json validates against schema
- Referenced markdown files exist
- Project appears on /apps listing with docs rendering
Task
This app needs documentation to appear on developers.whilesmart.com under the Apps section.
The site fetches docs from a
docs.jsonmanifest plus markdown files in adocs/folder at runtime.Action
docs.jsonmanifest (see template below)docs/installation.mdwith real install commanddocs/usage.mdwith basic usage exampleTemplate
docs.json{ "": "https://raw.githubusercontent.com/whilesmart/docs-kit/main/schema/docs.schema.json", "name": "Project Name", "description": "Short description", "icon": "lucide-icon-name", "category": { "language": "go" }, "sidebar": [ { "title": "Installation", "path": "docs/installation.md" }, { "title": "Usage", "path": "docs/usage.md" } ] }Note: For app,
category.frameworkis optional (omit for CLI/tools).Acceptance
docs.jsonvalidates against schema