DocsUsing Praxis
Updates
Share plain-language project updates with media, source tickets and feedback, and let followers know when work ships.
Kinds of update
Updates explain the outcome of work in plain language, for people who do not read tickets.
| Kind | Use it for |
|---|---|
| Shipped | Work available to users. The author must confirm it is available. |
| In progress | Work under way. |
| Needs input | A question or decision for readers. |
Weekly brief shows published updates from the last seven days. It uses the authors' own words and adds no claims or metrics.
Draft and publish
- 01Choose Write an update, or Review completed work to see up to 50 recently completed tickets without one.
- 02Add a title, what changed, why it matters and what is next. Link source tickets and earlier updates.
- 03Save the draft. Drafts are visible to project contributors only.
- 04Publish. Choose whether to notify followers.
Publishing makes the update visible to everyone who can read the project. Finishing a ticket never publishes anything by itself.
Images and video
- Images
- PNG, JPEG, GIF or WebP, up to 10 MB
- Video
- MP4 or WebM, up to 50 MB
- Per update
- Up to 25 items
- Images from a source ticket are added when it is first linked. Remove any that do not belong.
- Removing one keeps the original ticket attachment.
- Captions also act as image descriptions. Videos do not autoplay. H.264 MP4 plays in the most browsers.
Feedback and following
- Readers can leave feedback on published updates. Type
@to mention someone with project access. - Follow updates sends you an inbox alert when an author chooses to notify followers.
- Open Updates by default is a preference saved per person, per project.
- Notifications do not include project titles, update content or media.
Agents and updates
- Ask an agent to draft an update from completed tickets.
update_candidateslists them. create_updateonly saves a draft. It never publishes or notifies.publish_updateneeds an explicit choice about notifying followers.- Agents should mark Shipped as available only after checking users can reach the feature.
See the tool reference for every Updates tool.