Skip to content

docs: Add docs.json and markdown documentation #72

Description

@Lantum-Brendan

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

  • Create docs.json manifest (see template below)
  • Create docs/installation.md with real install command
  • Create docs/usage.md with basic usage example
  • Push to default branch

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions