Neo | DocsReferences
Neo works best if you give it access to documentation! When assigning work to Neo, link to things like:
-
A full PRD (Product Requirements Document)
-
A new API reference
-
An architecture documents
You can add references to tickets, and to comments on both tickets and pull requests.
Try to be specific about how Neo should use the document. Otherwise, Neo might not pay the attention you expect to the parts of the documentation that you are interested in. This is more noticeable on large documents.
How to reference something
The usual way is to copy and paste a link into a ticket or comment. This works for:
-
Links to documents in the document manager Neo is configured to for your project. e.g. Confluence or Notion. See Configure Document Manager
-
Links to source code or markdown files in open source repositories, or in the code repository you have configured for Neo.
-
Links to documentation on the public internet.
Depending on which tool you’re using, you can directly embed, paste or attach documents and images.
Neo will also try to work out what you mean if you just mention an item without an explicit link or embed. For example refer to the identifier of another ticket in the ticket system like CLOUD-1234.
⚠️ Currently Neo will follow only one level deep into any resource that is pointed at. If you need Neo to be aware of documentation in two or more pages, you need to link to each page explicitly.
Kinds of reference
-
Image - either embedded or attached. See Images for more details.
-
Figma designs - see Figma for details.
-
Work item - a link to a ticket in your project manager.
-
Web page - any public HTML web page.
-
PDF, Word .docx, text file - either a link to or an attached document.
-
Code - a link to a file, perhaps on a specific branch, in a code repository.