Skip to content

Documentation feedback

Updated 13 Jul 2026jirkamotejl

Goal: a project owner or client must be able to mark a concrete part of the documentation and explain why it is inaccurate, untrusted, unclear, or insufficient.

sequenceDiagram
  participant Reader as Documentation reader
  participant UI as Docs UI
  participant Store as Feedback store
  participant Owner as Area owner
  participant Agent as AI/docs agent

  Reader->>UI: Select paragraph or text
  UI->>Store: Store doc_path, block_id, selection, comment
  Store->>Owner: Create review item
  Owner->>Store: Add verdict or context
  Agent->>Store: Load open feedback
  Agent->>UI: Propose documentation update
FieldWhy
doc_pathWhere the issue appeared.
block_idStable paragraph or section identifier.
selected_textWhat the reader challenged exactly.
commentWhy the text is a problem.
reasonFactual error, unclear text, distrust, missing detail, other.
audienceClient, internal team, developer, integrator.
source_commitWhat the text was verified against, if known.

GitHub issues may be enough for internal feedback. For clients, a custom store or a small backend endpoint is better because clients should not need GitHub accounts.