Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ShaneK
changed the title
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
1 participant
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.
Issue URL: internal
What is the current behavior?
Currently, an agent reading the docs parses rendered HTML, which on a component page means digging prop tables out of
<table>markup and missing the playground examples entirely, since those mount on the client. This isn't ideal and can make it more difficult than necessary for LLMs to understand how to use Ionic Framework components.What is the new behavior?
A new
postBuildplugin writes/docs/llms.txtin the llmstxt.org format, 305 links grouped by the current version's sidebar categories, with api, cli and native under the spec's## Optionalheading. It also writes 608 markdown twins, one per sidebar-reachable page in both built versions, so/docs/api/buttonis also readable at/docs/api/button.md, which helps LLMs parse and understand things easier than HTML.Additionally, we added an alternate link to doc pages that links to the md pages, helping with discoverability.
Does this introduce a breaking change?
Other information