Editor
Format Issue descriptions and supporting Documents.
Plan your next milestone
Bring the details together in one place. Describe the outcome, add context, and give your team a clear next step.
Overview
Issue descriptions and supporting Documents use the shared Integrity editor. Use its toolbar or type / to choose a block. You can also paste Markdown, links, and spreadsheet cells, but not every external editor feature has an equivalent.
Document info and keyboard shortcuts
Open the page's More actions menu and choose Document info to see the document's word count, character count and estimated reading time. These details live in the page menu; comments and create dialogs show no statistics.
Choose Keyboard shortcuts in the same menu, or press Ctrl + / (Cmd + / on a Mac) while focused in an editor, to open the editor shortcut list. Close the list to return to your document or menu control.
Formatting
Select text for inline formatting. Use the slash menu for larger blocks.
Text styling
- Bold: Ctrl + B / ⌘ + B.
- Italic: Ctrl + I / ⌘ + I.
- Underline: Ctrl + U / ⌘ + U.
- Use the toolbar for strikethrough, inline code, and links. Choose headings from the slash menu.
The slash menu offers heading levels 1–3. To create any supported heading level from the keyboard, type one to six # characters followed by a space at the start of a line.
Lists
Choose a bulleted list, numbered list, or checklist from the slash menu. Checklists can contain nested items. A checklist is document content; checking it does not change an Issue's status.
With the cursor in a checklist item, press Ctrl + Enter / ⌘ + Enter to check or uncheck it. Ctrl + Shift + Enter / ⌘ + Shift + Enter gives the item and every checklist item nested in it the same new state. Each shortcut is one undo step. In editors where Ctrl + Enter / ⌘ + Enter submits, such as while creating an Issue, it keeps submitting.
Other formatting options
The slash menu includes tables, code blocks, blockquotes, dividers, callouts, collapsible sections, a table of contents, and commands for images, attachments, and email links. Use the block's controls for its available actions.
Rendered Mermaid diagrams are (coming soon). Store diagram text in a code block for now.
Attachments
Paste or drop PNG, JPEG, or WebP images up to 10 MiB into the description or a supporting Document, then wait for the upload to finish. If the editor asks you to create the Issue first, save it before adding the image.
For other files, use the Issue's Resources controls. Private file attachments support up to 100 MiB. The image limit and attachment limit are separate.
You can also choose Attach files… in the slash menu or press Ctrl + Shift + U / ⌘ + Shift + U. In a saved Issue or supporting Document, the files are added to its Resources. While creating an Issue, the same file picker as the dialog's paperclip opens and the files are attached when the Issue is created. Editors that cannot attach files, such as a Triage submission or a sub-issue draft, do not list the command.
Helpful commands
- Ctrl + Z / ⌘ + Z undoes your current typing.
- Ctrl + Shift + Z / ⌘ + Shift + Z redoes it.
- Shift + Enter adds a line break.
- Ctrl + Enter / ⌘ + Enter exits a code block.
- Ctrl + A / ⌘ + A first selects the current text block; press it again to select the whole document.
Undo is not a browsable history of saved document versions.
Pasting content and links
Paste Markdown to convert supported headings, lists, checklists, quotes, code blocks, and other formatting into editor content. Pasting spreadsheet cells creates a table. A single safe HTTP or HTTPS link becomes a clickable link, and a pasted rich-text link keeps its destination.
When the displayed text of a pasted URL is the URL itself, Integrity shortens it to the destination's hostname. Unsafe or unsupported link schemes remain plain text.
Select linked text and choose Open link, or hold Ctrl on Windows or Command on macOS while clicking an ordinary link. You can change its destination with Edit link or remove it with Remove link. These actions are also available in comment selections.
Gmail and Outlook message links can appear as readable link cards. They open the original message; Integrity does not import its body. Automatic Figma, Loom, and video previews are (coming soon). Use ordinary links instead.
When a connected agent replaces an Issue or Document through Integrity's Markdown interface, GitHub-style pipe tables are not preserved yet. Create or paste those tables in the editor until agent table round trips are supported.
Copy a description as Markdown
Open an Issue's … menu and choose Copy description as Markdown to copy its description with headings, lists, checklists, links, code blocks, and tables. Mentions are copied as the names you can see, and mentions you cannot access become Restricted item. Images are copied as an ![Image attachment] placeholder without their file address. If the description is empty, or its mentions are still loading, nothing is copied and Integrity tells you why. Copying does not change the Issue or notify anyone.
Emoji
Paste emoji or use your operating system's emoji picker. An editor-wide colon-name picker is (coming soon).
@ Mentions
In a primary Issue, Project, or Initiative description, type @ to mention a person, Issue, Project, or Initiative you can access. Structured mentions are also available in Issue comments.
Mentions in supporting Documents are (coming soon). Add a normal link there for now.
A mention or link does not grant access to its target. Readers who cannot access a mentioned object see a generic restricted reference instead of its identity. Document mentions do not subscribe people to the object or send mention notifications.