Neo | DocsContext documents
You can tell Neo about your company or team’s standards and processes by giving it those as documents.
Don’t worry about giving Neo too many documents or documents that also cover other topics, it only uses the parts it needs.
You could also write a document just for Neo, and put things in you find you need to instruct Neo.
Setting Context documents
💡 If Sagittal configured Neo for your projects, Contact Support and give us the links to your Ways of Working, Coding Standards and other documents and we’ll do this for you.
To tell Neo about these documents
-
Go to Neo’s Admin interface for the project
-
Make sure you have a Document Manager setup, e.g. Confluence.
-
Choose “Context documents".
-
Copy the URLs of the documents and paste it and click “Add”. It will confirm the document titles.
-
When you’ve added them all, choose “Save and Learn”.
It will take a few minutes for Neo to learn from your documents. From then on, Neo will relearn from the documents every couple of hours.
Things that can go in context document
Neo will use the relevant information from those documents in these ways:
-
Generating code - if you have code style guidelines, give those to Neo
-
Choosing branch names - give Neo your ways of working about branches
-
Ticket status transition - any rules for the ticket status Neo should use while working and when it has finished
-
Browsing the codebase - if you have a document describing the directory structure of your repository, give that to Neo
-
Commit message - if you need a special commit message format, for example using conventional commits, specify it in a context document
-
Spelling rules - when Neo reviews your PR, customise spellings it often gets wrong, or should be sure to check