Skip to content

docs: describe worklog posting on Jira, Linear, and GitHub#4

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/bf718ac0
Open

docs: describe worklog posting on Jira, Linear, and GitHub#4
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/bf718ac0

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 2, 2026

Copy link
Copy Markdown

Summary

Document the new multi-provider worklog posting flow so users understand what "posting a worklog" means on each supported issue tracker and how to set up the required credentials.

Changes

  • Jira guide — added a "What posting a worklog means on Jira" section explaining that worklogs land in the ticket's native Work Log tab via Jira's worklog REST API (Time Spent + comment), and clarified that the existing API token plus the standard "Work on issues" permission is all that's required.
  • GitHub & Linear guide — explained up-front that neither tracker has a native time-tracking API, so a worklog is posted as a structured ⏱ Worklog comment on the matched issue (Linear via commentCreate, GitHub via the issue-comments REST endpoint). Added provider-specific "What posting a worklog means" sections showing the comment format, the machine marker, and where the entry shows up in each UI.
  • GitHub token scopes — corrected the required scope: classic tokens need repo, fine-grained tokens need Issues: Read and write (read-only is no longer sufficient because the daemon now writes comments after approval). Clarified that GITHUB_ORG accepts an org slug or a personal username.
  • Linear key handling — noted the personal API key is sent raw in the Authorization header (no Bearer prefix) and that LINEAR_TEAM_IDS accepts team keys like ENG,DESIGN.
  • Dashboard guide — added a new Worklogs view section describing the shared draft → review → approve → post pipeline that powers all three providers, including the provider-specific final hop. Both tracker guides cross-link to it so the approval-gated flow is documented in one place.

Context

Source PR: Meridiona/meridian#102feat(worklog): Linear & GitHub worklog providers alongside Jira. Worklog posting now branches on a per-row provider snapshot taken at draft time, so the same approval gate and idempotency guarantees apply across Jira, Linear, and GitHub.

@mintlify

mintlify Bot commented Jun 2, 2026

Copy link
Copy Markdown
Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
meridiona 🟢 Ready View Preview Jun 2, 2026, 7:14 AM

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.

0 participants