HACKER Q&A
📣 tpurves

How should I design my API docs for AIs to read?


Say I have some SaaS APIs for sale, I'd like to make them not just developer friendly, but also AI friendly. I understand I could stand up my own chatGPT wrapper and feed in a vector database of my tech docs so developer could ask questions or get support that way. But what are the best practices here? How do I make my tech docs into the knowledge set of co-pilot AIs, or how do I make it easi(er) for developers to find or embed useful technical knowledge of my services into whatever third party AI tools they might be using or prefer?


  👤 dingotron Accepted Answer ✓
Hmm Github introduced something called github for docs, but it's waitlisted, and not very clear how it's going to be open to owners/publishers of docs vs users of docs. https://githubnext.com/projects/copilot-for-docs