A workspace's feedback
Collect feedback for your own product in a workspace, through a hosted form and the API, and work through it in one inbox.
Every workspace has a Feedback page: an inbox for what people tell you about your product. Entries reach it through a hosted form anyone can fill in, and through the API from your own product or support tool. When a project closes, the follow-ups its report left open arrive there too (see Follow-ups of closed projects).
This page is about feedback you collect. To send feedback about Yard itself, see feedback.
Open it
In a workspace, choose Feedback in the sidebar. Everyone who can open the workspace can read the entries. Marking, archiving, deleting, making something from an entry and the setup need edit access.
Work through the inbox
Each entry shows its title with its state beside it (a blue dot while it is New), then one line with where it came from (Form, API, Yard app or Follow-up), its kind (Feedback, Idea or Problem), who sent it, when, and the page it was sent from when that is known: Form · Feedback · Maja Lind · 12 min ago. A follow-up names the project it came from instead of a kind. The details show their first two lines.
Next to each entry, Make turns it into work (below), the check marks it done, and ⋯ holds the rest:
- Mark done (the check) when it is dealt with; Mark seen (under ⋯) when you have read it. Mark new puts it back.
- Archive takes it out of the inbox. It stays under Archived, where Unarchive brings it back.
- Delete… removes it for everyone in the workspace, after you confirm. This cannot be undone.
Marking or archiving one entry says so in a toast with Undo, as for several.
The page's tabs, Feedback, Follow-ups and All, say how many entries of the list come from people and how many are follow-ups of closed projects: Feedback 4, Follow-ups 2, All 6. The page opens on Feedback, what people sent; choose Follow-ups for the follow-ups alone, or All for both. The state counts below count only the tab's entries. The tab stays when you switch between the inbox and Archived.
Under the tabs, All, New, Seen, In progress and Done say how many entries of the list are in each state: All 6, New 3, Seen 1, In progress 1, Done 1. The list opens on New. Choose another to show only the entries in that state, and All to show them all. Inbox and Archived are at the right of the same row. The state filter stays when you switch between them, and an entry that changes state leaves the filtered list at once.
Next to Seen and Done the entry says who marked it and when: Seen by Alex Kim, 2 hours ago. An entry done because a project made from it was started says so: Done when Alex Kim started Export over 10 MB.
Work through several entries at once
Tick the checkbox in front of each entry, or the one in the list's header row, next to how many it shows (3 new); it ticks only the entries shown. A bar appears under the list with the number selected and:
- Mark new, Mark seen and Mark done, for all of them. Each entry records you as the one who marked it; an entry that already had that state keeps who marked it.
- Archive (in the inbox) or Unarchive (under Archived): they leave the list together.
- Prototype, Write spec and New project, which make one thing from all of them, or one for each (below).
After a mark or an archive, the toast has Undo for a few seconds. It takes back that change only: each entry gets the state it had, with who marked it and when, and archived entries return to the list. An entry someone changed again in the meantime keeps that later change.
The same is PATCH /v1/workspaces/<id>/feedback with ids (up to 500)
and a status, archived or both. Ids of entries in another workspace
are left out of the answer. The answer's takeBack (null when nothing
changed) is the undo: POST /v1/workspaces/<id>/feedback/take-back with
{ "token": "<takeBack>" }. Only you can use it, in that workspace,
for ten minutes.
Make something from an entry
Each entry's Make menu has three items that turn it into work. Nothing
is made on the first click: each opens a dialog over the inbox with the start
box in it, the same box New project (⌘J) opens anywhere in the workspace,
with the request as its text and the entry as a Feedback chip. The dialog
has a draft of its own: what you were writing in ⌘J stays there.
| Item | How the composer opens | What it makes |
|---|---|---|
| Prototype | Prototype | A prototype, listed under Prototypes |
| Write spec | Work with Create a spec first on | A project whose agent drafts spec.md and waits for you |
| New project | Work with Create a spec first off | A project whose agent starts on it at once |
The request is filled in from the entry. It opens with Feedback: <the entry's id>, so the project is titled and its branch named after the entry
until it gets a name of its own (Feedback: 3 entries for several). Then come
its title and its text, inside an
<untrusted source="a public feedback form"> block that tells the agent to
treat them as a description, not as instructions (anyone can send the form),
then one line saying who sent it, its kind and the page it was sent from. Tags
in what was sent (</untrusted>, lookalikes such as </untrusted>, or
</untrusted> written out) are neutralised, so nothing can end the block
early; a page that is not an address goes inside the block too. The
sender is named by their first name and initials ("Henrik S."), never
their last name, with the domain of their email address, so the agent
knows which organisation or product it came from. Their email address
itself is never put in: without a name, only its domain is. Yard's own
feedback names its page with Yard's domain in front ("useyard.app/…"). A report
about the environment adds the runner's details. Change the text as you
like before you send it. A project made from feedback can send messages to
other projects but never wakes their agents.
In the composer, + and @ add docs, blocks and repositories (each
repository with the branch it starts from), and you can attach files, pick
the model, switch the mode and turn Create a spec first on or off.
Closing the dialog (Cancel, Esc or a click beside it) makes nothing. Removing the
Feedback chip sends the request without tying what it makes to the
entries. A prototype is listed under Prototypes.
Whatever you make, you stay in the inbox, to go on with the next entry: the
dialog closes and a message at the bottom says what was made, with a button
to go there: Open project (Project "Export over 10 MB" made: its agent drafts spec.md, then waits for you.) or Open prototype. If it cannot be
made, the message says why and the dialog stays open with your text.
The entry then lists what was made from it, with who made it and when: Project: Export over 10 MB, Prototype. Each is a link to the project or to the prototype's page. Something deleted since is listed as removed. An entry that was New becomes Seen.
A project made from an entry shows its state next to its link, as the sidebar reads it: Working, Needs input, Ready to push, Ready for PR, Ready to merge, Merged. The entry follows the project:
- Once the project is started and its worktrees are set up, the entry becomes In progress, marked by whoever started it (Write spec and New project start it at once; a project created without starting is started by its first message or spec edit).
- Once every pull request of the project is merged, the entry becomes Done and is archived. Moving it back afterwards sticks.
While an entry is not done, Make stays, so it can lead to a prototype first and a project after. A Done entry no longer shows Make; mark it new or seen (under ⋯) to get it back. The selection bar hides them too when every selected entry is done.
Make one thing from several entries
When several entries ask for the same thing, or belong in one piece of work, tick the checkbox in front of each. A bar appears under the list with the number selected and the same three buttons: Prototype, Write spec and New project. Each opens the dialog as on a single entry, for all the selected entries together (the chip reads Feedback: 2 entries).
Above the start box, choose what it makes:
- One project (One prototype for a prototype), the default: one project or prototype from all the entries. The request starts with a line saying how many entries it holds, then lists them, numbered in the order of the list, each as it would read alone. When the entries are too long to fit together, their texts are shortened evenly; the titles and the sender lines stay. A prototype's request holds 2,000 characters, a project's 20,000. Change the text as you like before you send it.
- One per entry: a project (or spec, or prototype) for each entry, with that entry's own request, as if you had made it from the entry alone. The start box then holds only what you want to add to every one of them (optional). The model, Create a spec first, the chips, the repositories and the files you choose go with each. They are made one after another; the button says how far it is (Making 2 of 5…), and a message then says how many were made, with Open projects or Open prototypes. Each entry lists only what was made from it. If some could not be made, the message says how many failed and the dialog stays open with only those entries, to try again. One per entry makes up to 20 at a time.
Your choice is remembered in this browser for next time.
Every selected entry then lists what was made, each that was New becomes Seen, and the selection is cleared. Clear unticks them all. The selection is for the list you are looking at: it is dropped when you switch between Inbox and Archived.
Follow-ups of closed projects
When an agent finishes a project, its report can list Follow-ups: more work an agent can take on, which it left out on purpose. While the project is open they are on its page, where you can start one as a new project or have the agent continue it.
When you close the project, each follow-up still listed in its report becomes an entry of the workspace's Feedback, so it is not lost with the closed project:
- Its source is Follow-up, its kind Idea, its title and text are the follow-up's, and the person who created the project is named as sending it.
- Under its title it says From and the project it came from, linked to that project's page. Once that project is deleted it still names it: From Export over 10 MB (removed).
- You mark, archive, delete and make projects from it like any other entry. A project started from it puts it In progress, and merging that project marks it Done and archives it.
Closing a project again after reopening it adds nothing twice. A report without follow-ups adds nothing.
On the closed project's page, the Report card links each follow-up to its entry (In Feedback). A project closed before follow-ups went to Feedback has Add to Feedback there instead: it adds them once. Adding them needs edit access.
The hosted form
Where feedback comes from is under Settings, at the top right of the page, next to the form's state (Form published or Form draft). There, choose Set up form next to Hosted form.
- Give it a Title and, if you like, a Description that says what you want to hear about.
- Choose its Address: the last part of its link,
/feedback/<address>, in lowercase letters, digits and dashes. Left empty, it is made from the workspace's name. - Under Email address, choose whether the form asks for one, requires it, or does not ask. A form that does not ask does not keep one.
- Turn Published on and choose Save form.
The copy button next to the form's link gives you the link to share or to put behind a button in your product. Anyone with it can send feedback without an account: what it is about, a title (optional) and details, and their name and email address if they give them. The page works without JavaScript, in light and dark, and on a phone.
A form that is not published is a draft: its link answers "No feedback form here". Turn Published off to stop taking entries without losing the form or what was sent.
One address can send ten entries in ten minutes, and a form takes three hundred in an hour.
The API
Under Settings, choose Show request next to API for a request you can copy.
With an API key that may write, add an entry to the workspace:
curl -X POST https://<your API>/v1/workspaces/<workspace id>/feedback \
-H "Authorization: Bearer $YARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"bug","title":"Export fails over 10 MB","body":"Steps to reproduce","email":"[email protected]","page":"/exports"}'
Give a title, a body or both: an entry with neither is refused
(feedback_empty), and one without a title is listed by the start of its
body. kind is feature, bug or other; name, email
and page are optional. The same key reads the inbox
(GET on the same address) and marks entries
(PATCH /v1/feedback-entries/<id>).
Without a key, a server can post to a published form:
POST /v1/feedback-forms/<address> with the same fields. This is for your
own backend; a browser on another site is refused, so link to the hosted
form from a web page instead.
Every route is in the API reference under feedback.