webcanvas(docs): add llms.txt and llms-full.txt for AI usage#261
Open
webcanvas(docs): add llms.txt and llms-full.txt for AI usage#261
Conversation
tinyjin
force-pushed
the
jinny/wcanvas-llm.txt
branch
from
878fcf1 to
b9331a4
Compare
There was a problem hiding this comment.
Pull request overview
Adds AI-agent-friendly documentation outputs for the @thorvg/webcanvas API by extending the existing TypeDoc-based docs generator.
Changes:
- Generate
docs/llms.txt(high-level index) from the extracted API model. - Generate
docs/llms-full.txt(full reference with constructors/properties/methods/examples). - Copy both files to the package root (
packages/webcanvas/llms.txtandpackages/webcanvas/llms-full.txt) for easier discovery.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tinyjin
force-pushed
the
jinny/wcanvas-llm.txt
branch
from
0fde915 to
8f43633
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Modern AI coding agents can autonomously program based on well-structured, text-based API documentation. This patch provides the @thorvg/webcanvas API in formats that AI tools and coding agents can easily discover and understand through llms.txt format. The llms.txt is automatically generated based on typedoc document. In WebCanvas API doc, we'll provide original document for human-read, new document(llms.txt) for AI-read. see also : https://llmstxt.org/
tinyjin
force-pushed
the
jinny/wcanvas-llm.txt
branch
from
8f43633 to
ca47cb0
Compare
|
🚀 Playground preview deployment ready! 🎮 Playground: https://thorvg-playground-a20xdd30e-thorvg-web.vercel.app |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Modern AI coding agents can autonomously program based on well-structured, text-based API documentation. This patch provides the @thorvg/webcanvas API in formats that AI tools and coding agents can easily discover and understand through llms.txt format.
The llms.txt is automatically generated based on typedoc document. In WebCanvas API doc, we'll provide original document for human-read, new document(llms.txt) for AI-read.
see also : https://llmstxt.org/