Repository navigation
Add Roughdraft setup example document - #130
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
moiri-gamboni
pushed a commit
to moiri-gamboni/roughdraft
that referenced
this pull request
Sep 28, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a public Roughdraft example document that agents can download and open during setup.
Updates the setup guide to make opening that test document the first onboarding step, including the wait, inline reply, and reopen loop.
Updates the reusable agent prompt so future comments and questions get inline CriticMarkup replies before the document is reopened for continued review.
Validated with pnpm check and pnpm test:smoke.
Note
Low Risk
Changes are limited to public Markdown docs and the example asset; no runtime, auth, or application logic.
Overview
Adds a hosted
example.mdtest doc (with sample highlight, inline agent comment, and YAML endmatter) so onboarding can verify the full Roughdraft workflow.Setup now leads with First, Open a Test Document: download from
https://roughdraft.md/example.md(or hand-write ifcurlis missing), runroughdraft open, wait for Done Reviewing, then read the file, reply inline with CriticMarkup, save, and reopen for another round.The reusable
prompt.mdblock and the matching fallback text in setup extend the post-review step with that same inline reply → save → reopen loop, not only “respond to” comments in the chat.Reviewed by Cursor Bugbot for commit fbb81f4. Bugbot is set up for automated code reviews on this repo. Configure here.