Skip to content

docs: complete self-hosting guide and project documentation - #25

Merged
mariuspruvot merged 2 commits into
mainfrom
docs/self-hosting-guide
Apr 19, 2026
Merged

docs: complete self-hosting guide and project documentation#25
mariuspruvot merged 2 commits into
mainfrom
docs/self-hosting-guide

Conversation

@mariuspruvot

Copy link
Copy Markdown
Owner

Summary

  • README.md: full rewrite -- architecture diagram, how-it-works flow, skills table, documentation index. Replaces the bare-bones original.
  • docs/self-hosting.md: step-by-step guide from zero to running instance -- GitHub App creation, env config, 3 deployment options (Docker Compose, Coolify, any VPS), Claude credential setup, testing, and troubleshooting.
  • docs/architecture.md: mermaid system diagram, request flows (webhook, session start, multi-turn), module map with all endpoints, container lifecycle state machine, stream-json protocol, FIFO mechanism, security model, and database schema overview.
  • docs/creating-skills.md: walkthrough of building a custom skill from scratch (security-audit example), template placeholders, config reference, local testing, output conventions.
  • CONTRIBUTING.md: dev setup, code style, testing conventions, PR process, module layout pointer.
  • .env.example: improved comments with generation commands for every secret, grouped sections, fixed DATABASE_URL default (was localhost, now db for docker-compose).
  • CLAUDE.md: synced with main (mypy, CI coverage), added pointer to human-facing docs.

Test plan

  • All internal markdown links verified (20/20 resolve)
  • make lint passes (ruff + eslint)
  • Follow self-hosting guide steps mentally -- every command is copy-pasteable
  • Verify README renders correctly on GitHub

… docs

Complete documentation rewrite for self-hosters and contributors:
- README.md: scannable project overview with architecture diagram, quick
  start, skills table, and documentation index
- docs/self-hosting.md: step-by-step guide from zero to running instance
  (GitHub App creation, env config, deployment options, troubleshooting)
- docs/architecture.md: system diagram (mermaid), request flows, module
  map, container lifecycle, stream-json protocol, security model
- docs/creating-skills.md: walkthrough for building custom skills with
  a security-audit example
- CONTRIBUTING.md: dev setup, code style, testing, PR process
- .env.example: improved comments with generation commands for each secret
@helprs-local-mariuspruvot

Copy link
Copy Markdown

helPRs session created for this PR.

Skill: challenge-me | Open session

@mariuspruvot
mariuspruvot merged commit 754f8bc into main Apr 19, 2026
8 of 10 checks passed
@mariuspruvot
mariuspruvot deleted the docs/self-hosting-guide branch July 30, 2026 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant