For AI
The OneClick documentation is also available as plain Markdown files for AI assistants. The files follow the llms.txt convention. Give a file to your assistant, and it can answer questions from the documentation.
| Scope | Index | Full corpus |
|---|---|---|
| Whole site | llms.txt | llms-full.txt |
| Interface Builder | llms.txt | llms-full.txt |
The whole site has the OneClick, Interface Builder and Partner Portal documentation and the Changelog. The Interface Builder files have only the Interface Builder documentation.
Which file to use
llms.txt is an index. It has the title and a link for each page. Use it when your assistant can open URLs. The assistant reads the index and then opens only the pages that it needs.
llms-full.txt has all the pages in one file. Use it when your assistant cannot open URLs. Paste the file into the chat one time, and then ask your questions. The file is large and can be too large for a small context window.
One page as Markdown
Each docs page is also available as Markdown. Add .md to the path of the page. Use this form to give one page to your assistant.
- Page:
/docs/buttons/workflow-button - Markdown:
/docs/buttons/workflow-button.md
Example prompts
With the index, for an assistant that can open URLs:
Read https://help.theoneclick.io/llms.txt and answer my question. Get the pages that you need from the links in the index.
Question: How do I send a deal to my own server with a Workflow button?With the full corpus, pasted into the chat:
Below is the full OneClick documentation. Answer my questions with only this content.
[paste the contents of https://help.theoneclick.io/llms-full.txt here]
Question: How do I send a deal to my own server with a Workflow button?