Docs in reviews
Let the AI review and the story check read the workspace's library, so a change that goes against your documented rules is found with the passage that says so.
With docs on for reviews, the AI review of a pull request and the story check of a ticket can read your library. They look for passages that bear on the change or the story, and report each one with a quote: does the passage support it, contradict it, or just give context? This setting is off until you turn it on, per workspace.
#Turn it on
- Open Settings → Docs.
- Turn on Use reference docs in AI Review and press Save. It applies to this workspace only.
- Make sure the library has at least one built document.
#What changes
In a pull request review
The review checks the change against the rules and requirements the library documents. In the pull request’s AI Review tab:
- A Reference docs section lists the passages the review used, with counts of how many support or contradict the change. If the library has nothing that bears on it: “Nothing in the library bears on this change.”
- A finding that rests on the library carries a line “Reference: Document › Section”.
In a story check
The story check looks for passages that bear on the story and reports every contradiction between the story, its criteria or its code and the library, plus support where the library backs it. These show in a compact block in the Story check section.
#What stays the same
- The reviewer can read the library and nothing else new. It cannot change a document.
- Limn checks every reference before it shows it: the link must name a real section of a built document, and the quote must really be in that section. Anything else is dropped.
- References are not posted to GitHub; a link to your local library would mean nothing there.
- A change to the library does not make an earlier review out of date.
- With the setting off, reviews run exactly as they did before.
#Other uses of the library
- Check against docs works without this setting: you press the button on a ticket.
- Implement story can give its agent a copy of the sections that bear on the ticket.
- This Sprint’s summaries, themes and critical paths do not read the library.