docs: update repository guidelines and improve formatting across multiple files

- Enhanced AGENTS.md with clearer project structure and development commands.
- Updated CHANGELOG.md to reflect recent fixes and additions.
- Improved formatting in CONTRIBUTING.md for better readability.
- Adjusted package.json and configuration files for consistent command structure.
- Refined README.md and VISION.md for clarity and organization.
- Standardized code formatting in various TypeScript files for consistency.

These changes aim to enhance documentation clarity and maintainability across the repository.

2026-03-18 21:56:01 -05:00

1.1 KiB

Raw Blame History

summary

read_when

Mintlify setup notes for publishing docs/.

Setting up docs site

Mintlify

Goal: publish docs/ as a browsable docs site (nice UX for OSS users).

This repo does not include Mintlify config yet (mint.json missing).

Minimal setup

Install Mintlify CLI (per Mintlify docs).
Add a mint.json at repo root that points to docs/ pages.

Example (starter):

{
  "name": "ClawHub",
  "logo": "public/logo.svg",
  "navigation": [
    { "group": "Start", "pages": ["docs/README", "docs/quickstart"] },
    { "group": "Concepts", "pages": ["docs/architecture", "docs/skill-format", "docs/telemetry"] },
    { "group": "Reference", "pages": ["docs/cli", "docs/http-api", "docs/auth", "docs/deploy"] }
  ]
}

Notes:

Mintlify usually wants page paths without extension; keep files as .md.
If you prefer Mintlify conventions, rename to .mdx later (optional).

Recommended “docs UX” additions

Add an “Overview” page (use docs/README.md).
Keep “Quickstart” copy/paste friendly.
Provide CLI + HTTP API reference pages (done here).
Add a Troubleshooting page for common setup failures.

1.1 KiB Raw Blame History

Mintlify

Minimal setup

Recommended “docs UX” additions

1.1 KiB

Raw Blame History