Project docs

Each project has Docs: written pages for notes, specs and anything else that is not an issue. A doc belongs to one project and cannot move to another. Docs are written in Markdown and numbered, and the list can be filtered by title.

Internal and Shared #

A doc is either Internal or Shared. Internal docs are visible to staff, project admins and members. Shared docs are also visible to the project’s clients, who can read them and their history but never change them. New docs are Internal by default, and anyone who can edit a doc can change its visibility. Clients never see Internal docs. See client access.

Writing #

New doc opens a form with a title, visibility and a body. Use the Write and Preview tabs to check the result. Once the doc is saved, Edit shows a drop zone under the body for attaching files, and Insert on an image puts it into the text at the cursor. Eddyline warns you if you try to leave with unsaved changes.

Saving, conflicts and history #

Each save creates a new version. If someone else saved while you were editing, nothing is overwritten. The editor tells you and keeps your text so you can copy it and try again. History lists every version with its author. Open a version to read it, and use Restore this version to bring it back as a new version.

Duplicate and delete #

Duplicate makes a new doc with the same text, set to Internal. Attachments are not carried over, so images in the new doc do not show until you attach and insert them again. Delete asks for a second click and cannot be undone. Project admins and staff can delete any doc, and members only their own.

Mentions in docs are highlighted but do not send email.

Writing with Markdown #

Issue descriptions, comments and docs use GitHub-flavoured Markdown: headings, bold and italic, lists, task lists, tables, links, code and strikethrough. Raw HTML is removed.

• An issue key such as ACME-12 in the text becomes a link to that issue.
• Type @ and a name to mention someone. Mentions are highlighted, and in issues they send an email.
• In docs, images work only when they are attachments of that doc.