Skip to content

docs: add comprehensive documentation#2

Merged
marcosgz merged 2 commits intomainfrom
docs/add-documentation
Apr 19, 2026
Merged

docs: add comprehensive documentation#2
marcosgz merged 2 commits intomainfrom
docs/add-documentation

Conversation

@marcosgz
Copy link
Copy Markdown
Owner

Summary

Adds a 10-file documentation set under docs/:

  • Entry points: README.md, getting-started.md
  • Core concepts: processes.md, adapters.md
  • Operations: cli.md, middleware.md
  • SEO: extensions.md (image, video, news, hreflang, mobile, PageMap)
  • Runtime: events.md, rails.md
  • Reference: api.md

Test plan

  • Skim docs/README.md as a navigation entry point
  • Verify getting-started.md and processes.md examples match the current API
  • Verify adapter config tables match what each adapter exposes
  • Verify event names in events.md match what the gem publishes

Adds a 10-file documentation set under docs/ covering:
- Getting started, processes, adapters, CLI
- Rack middleware, SEO extensions, events, Rails integration
- Full API reference
@marcosgz marcosgz merged commit 0b1f8e6 into main Apr 19, 2026
4 checks passed
@marcosgz marcosgz deleted the docs/add-documentation branch April 19, 2026 12:12
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