README.md

reqbeat-docs

The authored developer documentation for reqbeat.com — the prose a human writes. Every .md file here is published to docs.reqbeat.com.

What belongs here, and what does not

This repo holds pages a person writes and maintains: guides, tutorials, the getting-started path, conceptual explainers.

It does not hold the API reference. That page is generated — docs.reqbeat.com/docs is rendered from the live OpenAPI feed on every publish cycle, so it can never drift from what the API actually serves. There is deliberately no hand-maintained copy of the schema anywhere, and a pull request that adds one will be declined. Link to the reference instead.

How a change reaches the live site

edit a .md file  ->  pull request  ->  review + merge to main
                                          |
                                          v
                        the site generator reads this repo on its
                        next publish cycle (every 3 hours)
                                          |
                                          v
                                  docs.reqbeat.com

There is no deploy step and no staging. A merged pull request is a shipped page, live within three hours. Review accordingly.

If a page fails to publish, the rest of the site is unaffected and the failure is stated on the docs host rather than replaced with a stale copy.

Contributing

See CONTRIBUTING.md — who reviews, how long it takes, and the two formatting rules the publisher enforces.