Waypoint Pro

Waypoint Pro plans and tracks work. Projects hold issues, issues move across a board through the project's workflow, and a backlog is planned into sprints. Open it from Waypoint in the admin sidebar (Waypoint).

What it does

• Projects - each with its own key (WEB gives issues WEB-1, WEB-2 and so on), its own workflow of statuses, issue types and priorities.
• Board - one column per status. Drag issues between columns to move them.
• List - every issue in a project, filtered and sorted.
• Backlog and sprints - order the work, plan it into sprints, run one sprint at a time and follow it on a burndown chart.
• Comments, mentions and watching - type @ to mention someone. Everyone an issue concerns is told about changes, in the admin and (optionally) by email.

Getting started

1. Open Waypoint in the sidebar.
2. Press + in the banner (New project).
3. Enter a Name and a Key (2 to 10 letters or digits, starting with a letter), and optionally a Description. Press Create project. The key cannot change later.
4. The project opens on its Board. Press Create issue at the foot of the first column, type what needs doing and press Enter. Or press + in the banner (New issue) for every field.
5. Drag the issue to In progress when work starts, and to Done when it is finished.
6. To work in sprints, open the Backlog tab, press Create sprint, drag issues into it and press Start sprint.

A new project starts with the statuses To do, In progress, In review and Done; the types Task, Bug, Story and Epic; and the priorities Highest, High, Medium and Low. Change them in the project's Settings tab.

Screens

The banner shows where you are (Waypoint, the project, the tab) and three buttons:

• + - New project on the home screen; New issue inside a project (not in an archived project).
• ? - How Waypoint works, a longer help panel.
• The cog - Waypoint settings (see "Settings").

Inside a project, tabs under the banner switch between Board, List, Backlog and Settings, with a link back to all projects.

Home

• Projects - a card per project with its open and done counts. Click a card to open its board. Right-click it (or Shift+F10) for Board, List, Backlog and Settings and workflow. Show archived appears when there are archived projects.
• My work - open issues assigned to you, in every project, soonest due first. Overdue ones are red. Click one to open it; right-click for more.

Board

One column per status, in the workflow's order, with a count on each.

Filters (remembered per project in your browser):

• Sprint - Running sprint (or all) (the default), All issues, Backlog only, or a named sprint.
• Assignee - Anyone, Me, Unassigned or a person.
• Type - All types or one type.
• Filter by key, title or label.

The bar also shows the running sprint and the days left, or "No sprint running".

To work on the board:

• Drag a card to another column to move it. If the project restricts moves, columns the issue cannot go to are dimmed while you drag and refuse the drop.
• Drag a card up or down within a column to reorder it.
• Click a card to open the issue.
• Create issue at the foot of the first "to do" column adds an issue by title alone. Enter creates it, Esc stops. A new issue goes into the sprint the board is showing, or the backlog.

The issue menu

Right-click an issue on the board, the list, the backlog or My work (or use its menu button, or Shift+F10) for:

• Open
• Move to - the statuses the workflow allows from where the issue is now.
• Assign to - Me, Nobody, or a person.
• Add to sprint / Move to sprint - a planned or running sprint, or Backlog.
• Copy key
• Delete... - removes the issue with its comments and history. This cannot be undone.

Every move you can make by dragging is also in this menu, so Waypoint works without a mouse.

List

Every issue in the project, with Key, Title, Type, Status, Priority, Assignee, Sprint, Est. and Updated.

• Filters: status (Open (not done), Any status, To do, In progress, Done, or one status), type, priority, assignee, sprint (including Backlog and closed sprints), and a Key, title or label search.
• Click a column heading to sort; click it again to reverse.
• Click a row to open the issue; right-click for the issue menu.

Backlog

The running sprint at the top, then planned sprints, then the backlog, then completed sprints.

• Backlog - every issue not in a sprint and not done, in the order you want them done. Drag issues up and down to reorder, or into a sprint to plan it. Done issues outside a sprint are hidden and counted. Buttons: Create sprint and New issue.
• Planned sprints - their dates (if set), issue count, story points and goal. Start sprint shows when the sprint can start. If it cannot, the reason is shown: another sprint is running, or the sprint is empty.
• The running sprint - its dates, days left, goal, a burndown chart and a Complete sprint button.
• Completed sprints - a fold-out list with each sprint's dates, how many issues were done, how many were carried over, and points. Click one for its burndown.

Right-click a sprint's header (or its menu button) for its actions:

Sprint	Actions
Planned	Edit sprint..., Start sprint (when it can start), Delete sprint... - its issues go back to the backlog
Running	Edit sprint..., Complete sprint, Burndown
Completed	Burndown

Starting a sprint

1. Press Start sprint.
2. Check the Name and Goal (what the sprint is for, in a sentence).
3. Pick Starts and Ends. The end is offered as the start plus the sprint length from Waypoint settings.
4. Press Start sprint in the panel. Only one sprint can run at a time, and an empty sprint cannot start.

Completing a sprint

1. Press Complete sprint.
2. Choose where the unfinished issues go under Move the ... unfinished issues to: a planned sprint or The backlog. They keep their place in the order.
3. Press Complete sprint. The sprint moves to Completed sprints and keeps its burndown, including the carried-over issues.

The burndown shows the sprint's remaining work against a straight line to zero on the end date. It counts story points when any issue in the sprint has an estimate, otherwise one per issue. In a sprint that uses points, an issue with no estimate counts as 0. Issues added mid-sprint raise the whole line.

Issue

Opens in a panel beside the board (its address is #/plugins/waypoint-pro/i/KEY-N, so you can share it).

• The head shows the key, the type and status, Watch (turn watching on or off) and a menu with Copy link, Copy key, Watch / Stop watching, Assign to me and Delete....
• Title and Description save with Save, Ctrl+S or Ctrl+Enter. Undo changes puts them back.
• Details on the right save the moment you change them: Status (only the moves the workflow allows), Assignee (with Assign to me), Priority, Type, Sprint, Epic, Estimate, Due and Labels (comma-separated).
• In this epic - for an epic, the issues inside it and how many are done.
• Comments - type @ and a name to mention someone. Ctrl+Enter or Comment posts. Your own comments have a menu with Edit, Copy text and Delete....
• History - every change to the issue.
• Reporter, Created and Updated.

New issue

Press + in the banner inside a project.

• Title (required), Type, Priority, Assignee, Sprint (Backlog means no sprint yet), Estimate, Due, Epic, Labels and Description.
• Create another keeps the panel open after Create issue, clearing only the title, description and estimate, for entering several issues in a row.

The assignee gets a notice and starts watching the issue.

Project Settings

The Settings tab of a project.

Details

• Name, Description - the Key is shown but cannot change.
• Lead - who runs the project. For information only; it grants nothing.
• Archived - an archived project takes no new issues and sits at the end of the project list behind Show archived. Its issues stay readable.

Workflow

• Statuses - the board's columns, in order. Each has a name and a category: to do, in progress or done. The burndown, the sidebar badge and "done" go by the category, never the name. New issues start in the first "to do" status.
• Restrict which moves are allowed - off means any status can move to any other. Tick it to choose, in a from/to grid, exactly which moves are allowed.
• Issue types and Priorities (highest first) - each with a name and an icon.
• Drag the grip to reorder (or Alt+Up / Alt+Down). Use Add a status, Add a type or Add a priority to add one, and the cross to remove one.
• Press Save workflow. An Unsaved tag shows until you do.

Renaming a status, type or priority never strands an issue. Removing one that issues still use is refused until those issues are moved.

Delete this project - removes every issue, comment, sprint and history line in the project. You must type the project's key to confirm. Archive it instead to keep the record.

Settings

Press the cog in the banner (Waypoint settings). Saving needs the Waypoint Manage permission.

• Email people about their issues - assignees, people mentioned and watchers get an email as well as the notice in the admin. On by default. It needs the site's email set up (System > Site Settings > Email); the panel tells you if it is not, and then only the admin notices go out.
• A new sprint lasts (days) - the end date offered when a sprint starts, 1 to 60 days. Default 14. You can still pick other dates each time.

Who is told about what

• The reporter, the assignee and anyone who comments start watching an issue automatically. Watch in the issue's head turns it on or off for you.
• Watchers, the assignee and anyone mentioned get a notice (the "Waypoint issues" notification) when the issue changes, and an email when that is switched on.
• Nobody is ever told about their own change.
• The Waypoint sidebar badge counts your open issues (assigned to you, not done). It turns red when one is overdue. Its popover lists them.

Permissions and roles

Waypoint adds one permission, Waypoint (group Plugins), in System > Roles:

Action	Label	Allows
waypoint.read	See	Open Waypoint; read projects, issues, comments and burndowns; watch issues
waypoint.write	Work	Create, edit and move issues; comment, and edit or delete your own comments
waypoint.manage	Manage	Create, change, archive and delete projects and workflows; plan, start, complete and delete sprints; delete issues; change Waypoint settings

The Admin role has all three by default.

Tips

• Set System > Site Settings > General > Site URL so links in Waypoint's emails point at the right address. Until it is set, the emails go out without links (nothing else is ever used as the address).
• Assignee and mention lists show active users who can read the project. Private projects restrict these lists to members and Waypoint managers.
• If you close a panel with unsaved text you are asked first. If you navigate away instead, what you typed is kept as a draft in this browser and offered back the next time you open that screen.
• Use labels and the board's filter box to find related work quickly.

Limitations

• A project's key cannot be changed.
• Only one sprint per project can run at a time.
• Permanently deleting an archived issue or a project cannot be undone. Archive an issue first to preserve its record.
• Descriptions and comments use sanitised Markdown.

Work controls (1.2)

• My work: choose Assigned to me, Reported by me or Watching. Open work is grouped by overdue, today, next seven days, later and no due date.
• Saved views: Board and List can save named filters per user and browser. Choose a view to restore it, Save view to replace it, Delete view to remove it, or Reset filters to start over. List also filters overdue work and reported/watched issues.
• Bulk edits: in List and Backlog, tick issue checkboxes or Select visible, then Edit selected to assign, prioritise, replace labels or schedule issues. Each issue has its own revision check. Successful changes are reported; failures stay selected for retry. Blank labels keep existing labels.
• Board: choose assignee or epic swimlanes. Managers can set WIP limits per status (blank/0 means unlimited). Limits apply across the whole project, including issues hidden by filters; the server refuses moves into a full column.
• Issues: descriptions and comments support sanitised Markdown and preview. Description checklists use - [ ] item and - [x] item; tick them and Save. Blocked by lists dependencies; cycles and self-links are refused, and blockers must be done before a dependent issue can finish. Links show both blocking and blocked work.
• Attachments: images, PDF, text/logs, CSV and JSON, up to 5 MB per file and 20 per issue. Files are private, outside public Media, and downloads require Waypoint Read. Waypoint Write permits uploads/removal. Archiving keeps files and references. Permanent deletion removes them.
• Concurrent edits: edits and moves require the revision returned when the issue was read. A stale change is refused; the editor preserves your draft and offers Reload latest. Review the saved draft before applying it to the newer version.
• Reporting: new sprints record dated scope, estimate, completion and reopening events. The ideal line uses the initial commitment, and closing freezes the report. Points charts warn about unestimated open issues. Legacy closed reports are frozen when the upgraded plugin starts. Existing active sprints record events from their next relevant change and explicitly mark the earlier history as unavailable.
• Permissions and recovery: read-only users see reading/watching controls; managers see project/sprint administration. Failed screen loads show Retry. Issues, comments and activity have paginated API reads; List offers Load more issues, and issue panels offer Load more comments/history.

API additions

GET /capabilities, POST /preview {text}, issue revision and blockedBy[], project wipLimits {statusId: number}. GET /projects/:id/issues?page=1&limit=100 returns {entries,total,page,limit} and accepts List filters/sorting. Comments and activity accept page/limit with the same response shape. Without pagination the original array response remains supported. PUT /issues/:key and POST /issues/:key/move require revision. Attachment POST accepts {revision,name,type,data} with base64 data; GET returns the authenticated file payload; DELETE accepts ?revision=N.

Testing

Waypoint API fixtures use an isolated directory under the system temporary directory and real CMS permission middleware. They never delete or recreate the checkout's live collections or use its users/mail credentials.

Teams and flow (1.3)

• Your notifications: use the banner bell to choose Mentions only, Assignments and mentions, All watched changes, Daily email digest, or Nothing. Email and in-admin notices have independent switches. Changes you make are excluded. Digests run at 09:00 UTC, survive restarts, retain up to 100 recent events per delivery, and retry failed sends. In-admin notices remain immediate in digest mode. Current project access is checked again before sending. Site email settings still apply.
• Project access: Settings → Project access switches between shared projects and selected members. Members retain their role permissions; membership alone grants no new write/manage rights. Waypoint managers can administer every project. Private projects are hidden from other users across searches, My work, badges, issues, comments, files and sprint reports. External plugin integrations see shared projects only.
• Templates: the Templates tab includes bug report, feature request and acceptance criteria starters. Managers can create, edit, duplicate, archive and restore templates through Domma context menus. New issue offers Apply template and asks before replacing entered fields. Templates contain title, description, type, priority, labels and estimate; they do not assign people or impose dates/sprints. Template edits use revisions.
• Archive: issue context menus archive instead of deleting. The Archive tab preserves read-only issues, comments, history and files. Managers can restore through its context menu, or permanently delete after typing the issue key. Restore checks WIP limits and places an issue in the backlog if its former sprint is closed or missing. Permanent project deletion still requires its key.
• Insights: select 7, 30 or 90 days for recorded time in status, average status visits, daily completions, median lead/cycle time, and current-status ageing. Issue rows use the same Domma context menus as the board/list. Old issues explicitly show incomplete history: new changes begin recording now; unrecorded status durations are not invented. Renaming a status preserves its ID and measurements. Archived intervals are excluded.

All new screens and forms use Domma Reactive observables, computed values and bindings. Menus use Domma E.contextMenu, with right-click, ⋮ and Shift+F10 support.

API additions

GET/PUT /preferences always acts on the authenticated user. Modes: mentions, assignments, watching, digest, none; switches: email, inApp. Project accessMode is shared or private; memberIds[] selects active users. GET /people?project=ID returns eligible people. GET/POST /projects/:id/templates, PUT /projects/:id/templates/:templateId (requires template revision). GET /projects/:id/metrics?days=30; GET /projects/:id/issues?archived=true supports normal paging/filtering. DELETE /issues/:key?revision=N archives; POST /issues/:key/restore {revision} restores. Permanent deletion requires DELETE /issues/:key?purge=true&confirm=KEY on an archived issue.