Skip to content

Documentation Site for Tiny Claw with LLM.txt Support #15

@warengonzaga

Description

@warengonzaga

📚 Documentation Site for Tiny Claw

Overview:
Tiny Claw currently has a landing page at tinyclaw.ai (hosted via GitHub Pages, built with Svelte 5 + Vite + Tailwind CSS inside src/landing/). We now need a dedicated, standalone documentation site separate from the landing page — one that is beautiful, professional, self-hostable, and AI-ready with LLM.txt support.


🎯 Goals

  • A clean, professional, and beautiful documentation site befitting Tiny Claw's identity.
  • LLM.txt support — making docs machine-readable and compatible with AI agents and LLMs.
  • Self-hosted preferred, but open to suggestions that are easy to maintain and deploy.
  • Separate from GitHub Pages to avoid limitations; ideally hosted on a custom subdomain like docs.tinyclaw.ai.
  • Works well with the project's existing Bun-native, TypeScript monorepo structure.

💡 Hosting & Platform Suggestions (Open for Discussion)

Platform Notes
VitePress Vue-powered, blazing fast, markdown-based, beautiful default theme. First-class LLM.txt support via custom pages. Great for self-hosting via Docker or VPS.
Starlight (Astro) Modern, accessible, stunning out-of-the-box. Fully static, easy to deploy anywhere. Strong community, supports custom LLM.txt route.
Docusaurus React-based, widely adopted, plugin ecosystem. Can self-host via Docker. Supports custom pages for LLM.txt.
MkDocs Material Python-based, beautiful, easy to write in Markdown. Great search, self-hostable. LLM.txt via custom hooks.
Fumadocs Next.js-based docs framework, stunning UI, built-in search, and growing ecosystem.

Maintainer's Preference: Self-hosted on a VPS or dedicated server via Docker. Suggestions on the stack are welcome!


✅ Must-Have Requirements

  • LLM.txt support at /llms.txt (and optionally /llms-full.txt) following the LLM.txt spec
  • Self-hostable via Docker or static file server
  • Custom domain support — docs.tinyclaw.ai
  • Dark theme support matching Tiny Claw's "Ant Colony" aesthetic (dark, earthy tones)
  • Full-text search (local or Algolia)
  • Mobile-responsive
  • Fast build & deploy via CI/CD (GitHub Actions)
  • Markdown/MDX-based content authoring

🌟 Nice-to-Have

  • Versioned docs (for future releases)
  • AI-powered search or chat widget
  • Auto-generated API docs from TypeScript types
  • Integrated changelog
  • OpenGraph meta tags for each page

📁 Suggested Repo Structure

src/
  docs/          # New docs site (alongside existing landing/)
    package.json
    docs/        # Markdown content pages
    public/
      llms.txt   # LLM.txt file

🔗 References


Note: As the maintainer, I'm open to all platform and hosting suggestions from the community. The priority is making the docs site look great, feel professional, and be easily maintainable. Drop your ideas below! 🐜

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation[Type] Improvements or additions to docs, README, or guides [issues, PRs]enhancement[Type] New feature or improvement to existing functionality [issues, PRs]

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions