[Docs] Add dedicated stylus support page and link it from FAQ#1045
[Docs] Add dedicated stylus support page and link it from FAQ#1045CodeDoctorDE merged 3 commits intoLinwoodDev:developfrom
Conversation
0b18d0a to
34e5234
Compare
CodeDoctorDE
left a comment
There was a problem hiding this comment.
Thanks for contributing.
However I would add more things
- Mention that the pen shortcuts can be configured in settings -> input -> pen
- Mention Pointer Test if something wrong. Primary Button corresponds to 10 (2), Secondary Button which corresponds to 100 (4) or 100000 (32). Also describe the button is a bit mapping
- Mention the new Pen Only Toggle that is activated if stylus has been detected (can be turned off in the pen input settings)
|
Thanks for the review — updated in the latest commit. Addressed all requested points:
Please take another look when you have time. |
There was a problem hiding this comment.
Pull request overview
This PR adds a dedicated documentation page for stylus/pen-input support in Butterfly, closing issue #1039. It consolidates information previously scattered across FAQ entries (platform support, settings, pen shortcuts, known Flutter framework limitations) into a single reference page, and adds links from the relevant FAQ questions to this new page.
Changes:
- Added a new
stylus-support.mdpage undercommunity/covering supported platforms, stylus settings, pen shortcut button values, and known Flutter tracking issues. - Added links from two FAQ entries (Mobile S-Pen and Desktop stylus) to the new page.
- Added a sidebar entry for "Stylus support" in the Community section of
astro.config.mjs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/src/content/docs/community/stylus-support.md |
New dedicated stylus support page with platform support, settings, shortcuts, and known issues |
docs/src/content/docs/community/faq.md |
Adds "See Stylus support" links before existing FAQ answers on S-Pen and desktop stylus topics |
docs/astro.config.mjs |
Adds "Stylus support" sidebar entry under the Community section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Primary button** commonly appears as `10` (`2`) | ||
| - **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) | ||
|
|
||
| These values are bit mappings from pointer button flags. |
There was a problem hiding this comment.
The button values listed — 10, 100, and 100000 — appear to be binary representations of the pointer button bit flags (where 10 in binary = 2 decimal, 100 in binary = 4 decimal, and 100000 in binary = 32 decimal). The page states "These values are bit mappings from pointer button flags," but does not clarify the numeric base being used. Without explicitly noting that these are binary values (or using a 0b prefix notation), readers are likely to interpret 10, 100, and 100000 as decimal numbers, which would be incorrect and confusing. Consider adding a clarifying note that these outer values are written in binary.
| These values are bit mappings from pointer button flags. | |
| These values are bit mappings from pointer button flags, where the outer values (for example, `10`, `100`, `100000`) are written in binary and the values in parentheses are their decimal equivalents. |
|
I have copilot reviewed the changes. Can you add a stylus_support translation in docs/src/translations/en.josn? |
|
Done ✅ Added Commit: 8b61faa |
|
thanks for contributing |
Summary
Closes #1039.
This adds a dedicated documentation page for stylus support and links to it from the FAQ entries that previously only contained short notes.
What changed
community/stylus-supportwith:Pen-only input,Ignore pressure,Input test)Why this helps
Users now have one clear page to check stylus behavior and known limitations instead of searching multiple FAQ snippets.
Risk
Docs-only change; no runtime behavior modified.