Skip to content

Generated a structured documentation site for claude-hud #230

@lban2049

Description

@lban2049

Hey Jarrod!

I generated a structured documentation site for claude-hud using DocSmith, an AI-powered docs generator that works as a Claude Code skill.

Live docs: claude-hud Documentation

The docs cover:

  • Overview — what claude-hud is and why it matters for Claude Code users
  • Getting Started — step-by-step installation including the Linux tmpfs workaround
  • Configuration — full reference for all 20+ options (presets, display toggles, colors, layout, usage limits)
  • HUD Elements — detailed breakdown of each statusline component (context bar thresholds, tool activity, agent tracking, todo progress)
  • Architecture — data flow from stdin JSON through transcript parsing to rendering
  • Troubleshooting — common issues organized by symptom

Available in English and Chinese.

Why this could be useful:

  • With 20+ config options and platform-specific setup steps, a navigable site is easier to browse than scrolling through the README
  • The architecture page should help new contributors get oriented in the codebase
  • Docs can be updated incrementally as features ship

I can help maintain this if you want to keep it around.


How it was made:
DocSmith analyzes the codebase and generates structured documentation with a single command. It supports 35+ AI coding agents and can publish to the cloud instantly.

  • Install: npx skills add AIGNE-io/doc-smith-skills
  • Generate: /doc-smith-create
  • Publish: /doc-smith-publish

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions