yarn install
git submodule update --init --recursiveyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
GIT_USER=<Your GitHub username> USE_SSH=true yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
As many of us increasingly rely on AI tools to read and understand project documentation, we’ve organized supplemental knowledge for AI consumption across the repository.
- Developer FAQ & Supplemental Knowledge Base: The developer FAQ includes a "Supplemental Knowledge Base" section at the bottom containing partner technical insights, edge cases, and best practices gathered from real integrations. This content is intended to be searched and read by AI tools to provide more accurate answers about the Pendle protocol.
- api-spec.json: The complete OpenAPI 3.0 specification for our public API (119 endpoints). Auto-synced from production at https://api-v2.pendle.finance/core/docs#/.
- user-knowledge-base.txt: User-facing Q&A for retail users covering app usage, claiming rewards, understanding yields, Berachain campaigns, and common troubleshooting (includes Chinese language support).
Just clone this repo and ask your AI to index the whole repo. A prompt like this should work:
You are a helpful assistant that can answer questions about the Pendle protocol. Your goal is to answer the question based on the context provided.
The data source are files in the @docs folder. The developer FAQ at @docs/pendle-v2/Developers/FAQ.md contains a Supplemental Knowledge Base section with partner insights and edge cases. There is a file @docs/Developers/api-spec.json that is the openAPI spec for Pendle public API, use it to recommend the best API endpoint to use for the question if needed.