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.2 KiB

Raw Permalink Blame History

summary

read_when

Documentation index + reading order.

New contributor onboarding

Looking for the right doc

Docs

Reading order (new contributor):

README.md (repo root): run locally.
docs/quickstart.md: end-to-end: search → install → publish → sync.
docs/architecture.md: how the pieces fit (TanStack Start + Convex + CLI).
docs/skill-format.md: what a “skill” is on disk + on the registry.
docs/cli.md: CLI reference (flags, config, lockfiles, sync rules).
docs/http-api.md: HTTP endpoints used by the CLI + public API.
docs/auth.md: GitHub OAuth + API tokens + CLI loopback login.
docs/deploy.md: Convex + Vercel deployment + rewrites.
docs/troubleshooting.md: common failure modes.

Feature/ops docs (already present):

docs/spec.md: product + implementation spec (data model + flows).
docs/security.md: moderation, reporting, bans, upload gating.
docs/telemetry.md: what clawhub sync reports; opt-out.
docs/webhook.md: Discord webhook events/payload.
docs/diffing.md: version-to-version diff UI spec.
docs/manual-testing.md: CLI smoke scripts.

Docs tooling:

docs/mintlify.md: publish these docs with Mintlify.

1.2 KiB Raw Permalink Blame History

Docs

1.2 KiB

Raw Permalink Blame History