A pull request for your docs.
Every change, written by a person or proposed by AI, goes through one review before it reaches a reader. Approve it, publish it, and the people who depend on it can be notified.
Change requests › #418
In reviewDocument the idempotency header
Opened by Gravity from a change to src/gateway.go
API reference › Keys › Rotate an API key
−Retrying a request issues another key.
+Send an X-Idempotency-Key header so a retry returns the same key.
Priya · API team
Clear. Could we add an example request with the header?
There is no way to publish that skips review
Human edits, AI suggestions and generated updates all arrive as change requests in the same queue. Readers only ever see what someone on your team has approved.
Four stages, one loop for every change.
Whether a person wrote it, an AI suggested it or Gravity generated it from your code, a change moves through the same stages before a reader sees it.
Draft
Someone is writing, or Gravity is drafting an update from a code change. Only your team can see it.
Document the idempotency header
Drafted by Gravity from a change to src/gateway.go
Visible to your team only
Still being written. Readers see the current page.
Ask for changes in plain words.
Reviewers say what they want, the way they would to a colleague. The AI revises the draft and replies on the thread, and the reviewer approves when it is right.
Ask, as Priya:
Authentication guide
Revision 1Pick a request to see the draft revised.
Waiting on a revision
Governed by default, not by policy.
The control your security and compliance teams want, without slowing your writers down.
Required reviewers, per project
Decide who must sign off before anything publishes, with different rules for your public reference and your internal runbooks. The rule is enforced, not advisory.
Approval rules
Change request #418 · tick who has approved
Waiting for Security.
A full history, kept for audit
Every change request, comment, approval and publish is kept and searchable, so you can always show what changed and who approved it.
History · #418
LiveGravity opened #418 from a code change
09:02Priya requested changes
09:14Gravity revised the draft
09:15Priya approved
09:21Marco approved as required reviewer
09:40Priya published the change as version 15
09:41
Publish, and the right people know.
When a change goes live, the people who depend on that page can be notified. It is also the record of changes your security and compliance reviews expect.
Ready to publish
ApprovedRotate an API key
Version 15 · docs.acme.com/guides/rotate-keys
Platform team
Follows the API reference.
Acme integrations
Follows Authentication.
Partner success
Follows breaking changes.
Untick “Notify page followers” to publish quietly.
Explore the rest of Gravity
Each part works on its own, and better next to the others: one path from a code change to a reader’s answer.
Give every change one review loop.
Connect your docs and your code, and publish your first reviewed, recorded version.