Keep API reference in separate file #7
Description
Main README is too long, need to break it down into parts for easy LLM consumption (for AI-assisted coding).
- Use TSDoc to annotate the functions in our code, parse them (you can try using https://github.com/peterpeterparker/tsdoc-markdown) and create the API_REFERENCE.md file through a package script (e.g.
npm run generate:api-reference) - Keep API_REFERENCE.md a separate file, reference it as a link in the README.