Skip to content

docs: add comprehensive documentation#12

Merged
marcosgz merged 1 commit intomainfrom
docs/add-documentation
Apr 19, 2026
Merged

docs: add comprehensive documentation#12
marcosgz merged 1 commit intomainfrom
docs/add-documentation

Conversation

@marcosgz
Copy link
Copy Markdown
Owner

Summary

Adds an 11-file documentation set under docs/:

  • Entry points: README.md, getting-started.md, configuration.md
  • Core concepts: consumers.md, producers.md, middleware.md
  • Runtime: cli.md, supervisor.md, web.md
  • Ecosystem: testing.md, rails.md

Covers the full consumer/producer DSL, built-in middlewares, supervisor process model (fork hooks, signal handling, graceful shutdown), the CLI (lepus start, lepus web), and the web dashboard. Includes Rails-specific guidance (Railtie, executor wrapping, Puma plugin).

Test plan

  • Skim docs/README.md as a navigation entry point
  • Verify consumer/producer DSL examples match the current API
  • Verify middleware list in middleware.md matches what ships in the gem
  • Verify CLI flags in cli.md match what bundle exec lepus start --help shows
  • Verify the signal table in supervisor.md matches actual behavior

Adds an 11-file documentation set under docs/ covering:
- Getting started, configuration
- Consumers, producers, middleware
- CLI, supervisor, web dashboard
- Testing, Rails integration
@marcosgz marcosgz merged commit 5b9a58a into main Apr 19, 2026
14 checks passed
@marcosgz marcosgz deleted the docs/add-documentation branch April 19, 2026 12:22
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