Skip to content

docs(task-tracking): sharing issues via @-mentions#72

Open
MichaelUray wants to merge 2 commits into
hcengineering:mainfrom
MichaelUray:feat/mention-grants-docs
Open

docs(task-tracking): sharing issues via @-mentions#72
MichaelUray wants to merge 2 commits into
hcengineering:mainfrom
MichaelUray:feat/mention-grants-docs

Conversation

@MichaelUray
Copy link
Copy Markdown

@MichaelUray MichaelUray commented May 30, 2026

Documents the mention-grants feature shipping in hcengineering/platform#10895.

What this adds

A new page Sharing issues via @-mentions under task-tracking that covers:

  • When the send-time disclosure dialog appears (mentioned person is not a project member)
  • The per-grantee choices: grant access or don't grant, plus cancelling the send to skip the mention entirely
  • What the mentioned person sees in their tracker navigator (dimmed icon + "Shared with you" tooltip; Issues-only sub-view)
  • The per-mention opt-out via grantsAccess="false"
  • Add-only re-grant semantics on comment edits
  • Which document classes opt in today (tracker.class.Issue only)
  • How to extend to other classes via the ClassCollaborators.mentionsGrantAccess flag

Includes four privacy-filtered screenshots covering the mention picker, disclosure dialog, shared navigator state, and collab-only issue view.

Touched files

  • src/content/docs/task-tracking/sharing-via-mentions.mdx (new)
  • src/content/docs/task-tracking/issue-collaborators.mdx — cross-link to the new page from the "Subscribed view" section
  • astro.config.mjs — sidebar registration under Task-tracking

Sign-off

Single author, signed-off, DCO-compliant.

Document the mention-grants feature (companion to hcengineering/platform PR
#10895):

- New 'Sharing issues via @-mentions' page in task-tracking section
  covering the disclosure dialog flow, what the mentioned person sees in
  their navigator, the per-mention opt-out via grantsAccess='false', and
  the add-only re-grant semantics on comment edits.
- Cross-link from existing 'Issue collaborators' page so the manual and
  mention-driven paths discover each other.
- Sidebar registration in astro.config.mjs under task-tracking.

Screenshots intentionally deferred to a follow-up commit on this branch
(capturing them requires a privacy-filtered test workspace and is in
progress). Text describes the flow in sufficient detail for review;
screenshots will be added before merge.

Signed-off-by: Michael Uray <michaeluray@users.noreply.github.com>
Four screenshots captured on a privacy-filtered Test-Workspace
(no real customer data; the only real name visible is the author's
own per his explicit consent):

- composer-mention-picker.png — comment composer with the @-mention
  picker open, showing the Employees / Meeting Minutes / Issues
  sections.
- disclosure-dialog.png — the 'This mention grants access' dialog
  that opens at send time when the mentioned person is not a project
  member, with a per-person checkbox and Cancel / Send-with-grants
  buttons.
- navigator-shared-badge.png — the mentioned person's tracker
  navigator showing a regular-membership project alongside a
  collab-only project (dimmed icon, only Issues sub-view).
- issue-from-collab-view.png — the issue page as seen by the
  mentioned person, with comment composer and activity feed
  including the granting mention.

The body of the page is updated to reference each screenshot with
descriptive alt text. The dialog choice description is also
tightened from three options (Grant / Don't grant / Skip mention)
to two (Grant / Don't grant) plus the existing 'Cancel to skip the
mention entirely' wording, since the rendered dialog presents
checkboxes per grantee, not a three-option row.

The synthetic Person record used to trigger the disclosure dialog
was removed from the workspace after the screenshot was captured.

Signed-off-by: Michael Uray <michaeluray@users.noreply.github.com>
@MichaelUray MichaelUray marked this pull request as ready for review May 30, 2026 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant