Tidepool documentation
Tidepool renders Mermaid diagrams in Confluence pages and Jira issues, with a live editor, dark mode and AI drafting. It runs entirely on Atlassian's Forge platform.
Install
- A site admin opens Apps › Explore more apps in Confluence or Jira and searches for Tidepool.
- Click Get app and start the trial. Sites with up to 10 users are free.
- No configuration is needed. Tidepool works for everyone on the site straight away and follows your existing page and issue permissions.
Confluence: add a diagram
- Edit a page and type
/Tidepool, then choose Tidepool diagram. - The editor opens. Write Mermaid in the Code tab, pick a starting point in Templates, or describe what you want in Prompt.
- The preview on the right updates as you type. When it looks right, click Insert and publish the page.
- To change a diagram later, edit the page and open the macro again.
If the page already has diagrams from another Mermaid app, the editor offers to bring them into Tidepool so you can keep them after you remove the old app.
Jira: diagrams on an issue
- Diagrams section: open an issue and find Diagrams in the right-hand column. Click New diagram to open the same editor. Diagrams are saved on the issue itself.
- Mermaid in descriptions: any
```mermaidcode block in an issue description is rendered in the Diagrams section automatically. - Map linked issues: from the issue's ••• menu, choose Map linked issues to draw the parent, subtasks and links as a live flowchart coloured by status. Save it as an editable copy if you want to annotate it.
- Search: find issues that have diagrams with the JQL
tidepoolDiagrams > 0.
AI drafting
- Open the Prompt tab, describe the diagram in plain English, and click Create new diagram. Use Revise this diagram to change it with another sentence.
- When a diagram won't render, Tidepool points at the broken line and offers Fix with AI.
- Every AI draft lands in the editor, so you can undo it, restore an earlier version from History, or edit the code.
- AI requests are processed by Atlassian's Forge LLM service. Each site gets a monthly allowance of AI drafts at no extra cost.
- On sites with Rovo, ask the Tidepool diagrammer agent to turn any page or issue into a diagram, then paste it into Tidepool.
- Already have Mermaid from ChatGPT, Claude or Copilot? Paste the whole
```mermaidblock into the Code tab and Tidepool strips the fence.
Viewing, export and themes
- Diagrams are pre-rendered for light and dark mode when saved, so readers never wait and they match the viewer's theme.
- Use the toolbar to zoom, open full screen, copy the source, or download SVG or PNG.
- People who can view a page or issue can view its diagrams. Only people who can edit it see edit controls.
Supported diagram types
Everything Mermaid supports, including flowchart, sequence, class, state, ER, Gantt, pie, mind map, timeline, journey, git graph, quadrant, sankey, XY chart, block, packet, kanban and architecture diagrams. Templates are provided for the nine most common types.
Licensing
Tidepool is free for sites with up to 10 users and paid per user above that, billed by Atlassian. If a site's license lapses, existing diagrams stay visible but editing and AI drafting pause until the license is renewed.
Limitations
- Jira mobile apps and the Jira Service Management customer portal are not supported yet.
- Very large Jira diagrams are compressed to fit Jira's issue property size limit.
Data and privacy
Tidepool makes no external network requests and stores no personal data. Diagrams live in your Confluence pages and Jira issues. See the privacy policy for details.
Help
Use Report a problem inside Tidepool, open an issue on GitHub, or email support@tidepoolapp.dev. More on the support page.