Repository navigation
An illustrated five-minute guide to writing in writui - #24
Merged
Merged
Conversation
Add a sample writing session to the site and README, with a short feedback form for first impressions and returning use. Show the existing writing screenshot in the README and record the focus on regular writers.
🚀 Deploying Preview to Cloudflare 🚀Preview Deployments by commit
|
Link the illustrated guide from the demo caption and README. Add compact copyable Markdown, linked steps, and full-size screenshots that open in new tabs. Keep all six images loading upfront and compress them losslessly.
aakashns
changed the title
aakashns
added a commit
that referenced
this pull request
Oct 19, 2026
Since pull requests started being squash-merged (from #24), the release notes found no merge commits and came out empty but for the changelog link, as on 0.18.0 and 0.19.0. A squashed pull request is now found by the "(#N)" its commit ends with, and its own commits are fetched from GitHub, so each one's full message is listed as before. Merge commits still work the same. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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.
New visitors can follow an illustrated five-minute writing session from the caption below the homepage demo or from the README. The guide walks through installing writui, creating their vault, writing a post, saving a version, and returning to it. A short GitHub feedback form asks what got in the way and whether they would return.
The guide includes six cropped, lossless WebP screenshots totaling 131 KB, 78% smaller than the original captures. They load upfront, have white borders, and open at full size in a new tab. The introduction links to each step, and the example has a Copy button that preserves its literal Markdown and compact spacing. A recording script makes the screenshots reproducible using synthetic writing in an isolated development vault.
Try it
gh pr checkout 24 && cargo runDebug builds use
.dev-data/, separate from your real vault. Usewritui-devas the development password.To preview the site:
Open the homepage and follow the demo caption to the writing guide. Try copying the example and opening a screenshot. Review the feedback form in
.github/ISSUE_TEMPLATE/writing-feedback.yml; it becomes available after this PR is merged.Validation
Site and documentation changes only; no app version bump. No product questions are outstanding.
Screenshots