defold / defold/doc

“Report a mistake” feature to defold.com

Open
#679 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
146
Forks
128
Avg merge
1d 10h
Merged PRs (30d)
9

Description

ould be useful to let visitors report mistakes directly while reading documentation on defold.com. This would make it easier for the community to help improve manuals, tutorials, and their translations.

Proposed behavior:

- When a visitor selects text, show a small, dismissible “Report a mistake” prompt in the bottom-left corner.
- Clicking the prompt opens a feedback form with the selected text, page URL, and language filled in automatically.
- The visitor can describe the problem or suggest a correction before submitting.

This should work on both English and translated pages, covering typos, translation errors, and unclear or outdated information. The prompt should remain unobtrusive and preserve normal text selection and copying.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing how defold.com serves English and translated documentation pages, then identify the entry points for text selection and visitor feedback. The work is done when selected text, page URL, and language populate a dismissible report form on both English and translated pages, while selection and copying still work normally.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.