On this page
How-to
Send feedback about a page
Send feedback adds Feedback to the side menu on every page, and Send feedback to the menu on a phone. Pages with no side menu, such as the set-up, have a Send feedback button instead. Use it to report something that is broken or hard to use, suggest something, or check a page for accessibility problems. Each report says which page and which part of it, and keeps nothing personal. It uses Snaglist.
The chart in words
Start: You want to tell us about a page
- Then: Is Feedback in the side menu?
- No: 1. It is on already
- Yes: What do you want to do?
- Report a problem or suggest something: 2. Send a report
- Read the reports you saved: 3. Find the reports saved in Starboard
Before you begin
- You are signed in to Starboard.
1 It is on already
Send feedback is active on every page unless you deactivate it. To hide it:
- Go to Settings, then General, then Logs and feedback.
- Under Send feedback, deactivate Send feedback. Activate it again the same way.
2 Send a report
- On the page with the problem, select Feedback in the side menu. On a phone, open the menu and select Send feedback.
- Choose what you want to send, such as Something is broken or A new feature.
- Choose what to show: One thing on the page, A series of steps or Describe it in words. For one thing, select the part of the page it is about.
- Answer the questions, then select Review what is sent. The whole report is shown, and you can clear anything you would rather not send.
- Choose where it goes: - Open in GitHub opens a new issue on Starboard's GitHub page with the report filled in. You post it from your own GitHub account. - Save in Starboard keeps it on your server. Starboard shows Saved in Starboard. - Copy as Markdown or Download gives you the report to send another way. - Show as a QR code opens the same report on your phone, for a computer that is not online.
3 Find the reports saved in Starboard
- Go to Settings, then General, then Logs and feedback.
- Under Send feedback, the saved reports are listed, newest first. Open The full report to read one.
- Select Mark fixed when it is dealt with. To delete one, select More actions, then Remove, then Remove report.
- Select Download all to save every report as one file.
Things to note
- A report never holds your password, your API keys, cookies or anything entered in the page's fields. Email addresses, long numbers and keys are replaced. The page title and the text on the page are copied as they are, so check the report before you send it.
- Reports saved in Starboard are kept on the server in
data/ux-notes.json, which only Starboard's user can read. They are in Starboard's backups. - Feedback loads only while Send feedback is active, so it costs nothing when it is not.
- Notes from the older Note an issue button are kept and listed with the new reports.
If it does not work
- No Feedback in the side menu: check that Send feedback is active, then reload the page.
- Save in Starboard says it is not sent: you were signed out. Sign in again, then send it again. The report is kept until you close the window, so you can also select Back and copy it instead.
- Open in GitHub does nothing: your browser may have blocked the new window. Allow pop-ups for Starboard, or copy the report and paste it into a new issue.
Find out more
This page on GitHub, where the help is written.