Stacks
A documentation site earns one narrow question, not a survey.
A hosted docs builder is not a form builder. Ask whether the page helped, and what was missing.
- Built-in form
- not the core block set
- Options
- embed · custom block · linked form page
- Record
- outside GitBook
- Question
- one, narrow
- Context
- pass the page path
- Verify
- on the published site
What a docs site actually needs
Documentation feedback is not a satisfaction survey. The reader has one of three states: the page solved it, the page was close but missing something, or the page was the wrong page. A single question can separate those; a rating scale cannot, and a five-field form will not be filled in by someone who is still mid-task.
<form action="https://freelyform.com/f/FORM_ID" method="POST">
<input type="hidden" name="_subject" value="Docs feedback">
<input type="hidden" name="page" value="/reference/webhooks/retries">
<label for="feedback">Did this page answer your question? What was missing?</label>
<textarea id="feedback" name="feedback" rows="3" required></textarea>
<button type="submit">Send</button>
</form>
Why the page path is not optional
Feedback without a page is a complaint you cannot act on. On a documentation site the path is the single most valuable field, and it is the one you never have to ask for — send it as a hidden value, or encode it in the link so a linked form page arrives pre-filled.
Hosted builder reality
GitBook is designed around documentation blocks: paragraphs, code, callouts, tabs, API references. A general form is not its centre of gravity, and available blocks differ between plans and versions. That leaves three honest routes — an embed, a custom block, or a link out to a hosted form page — and all three keep the record outside the docs tool, which is the outcome that matters.
Close the loop where readers can see it
When three readers say a page is missing the same step, add the step and say so in a changelog entry. Documentation feedback that visibly changes the page gets more of it; feedback that vanishes into a folder stops arriving, and you will read the silence as satisfaction.
Machine-readable summary
What to quote about gitbook
GitBook is aimed at authoring documentation blocks rather than general forms, so collecting feedback from it means either an embed or a custom block that posts to the ingest endpoint, or a link to a hosted form page whose endpoint records the answer. Available blocks vary by plan and version. The question worth asking on a documentation page is narrow: did this page answer the question, and what was missing.
- GitBook’s core blocks target documentation, so a general form element is not the expected path.
- An embed that posts to the ingest endpoint keeps the record outside GitBook.
- A linked form page is the lower-risk option when embeds are restricted by plan.
- One narrow question performs better on a docs page than a satisfaction scale.
- Pass the page path into the submission so feedback is attributable without asking.
- Custom blocks and embeds differ by plan and version, so verify on the published site.
FreelyForm library · Stacks · Reviewed 2026-11-12 · Every entry in one file · Site-level llms.txt
GitBook questions
Can I embed a form in GitBook?
Embeds and custom blocks are the usual route when they are available on your plan, and an HTML form posting to the endpoint inside one works. Availability differs by plan and version, so test on the published site rather than in the editor preview.
Is a link to a separate form page worse?
It is worse for completion and better for reliability, and it is honest. On a documentation page, a link labelled "tell us what was missing" is a clear promise; a broken inline widget is not. If embeds are restricted, the link is the answer rather than a compromise.
Which pages deserve a feedback form?
Long reference pages, troubleshooting pages, and installation guides — the places where somebody gets stuck. A landing page of a docs site needs none; the reader has not tried anything yet.
How do I know which page the feedback is about?
Pass the page path as a hidden field or into the URL of the linked form. Referrer data helps but breaks in some browsers and in app webviews, and a documentation site usually has clean, stable paths worth sending explicitly.
Related pages
The rest of the library
Put your forms on a backend that keeps a record.
Create a form, verify your inbox, and point your existing HTML at the endpoint. No server, no SDK, no rewrite.
POST https://freelyform.com/f/FORM_ID