brillout / brillout/docpress

Make HTML more AI friendly

Open
#155 0 comments 0 reactions 0 assignees View on GitHub
ai 🤖 discussion :thinking:
Dominant language
TypeScript
Stars
14
Forks
7
Avg merge
14m
Merged PRs (30d)
3

Description

See:
- https://github.com/brillout/docpress/pull/76#issuecomment-3514183091

Another example: AI seems to also struggle parsing the https://telefunc.com/event-based page (when I point it to that page, it doesn't understand that a `.telefunc.js` file should be named after the file name of a component). I suspect a similar issue where information isn't clearly available when only reading HTML.

This seems to be a quick-win that is relatively easy to implement? (And in general and regardless of whether we go down the `llm.txt` path, it's always good to have HTML that clearly expose all the information to AIs.)

So far, I think we should do this only to improve AI's crawling of Vike docs via HTML. To improve user's AI experience, we should probably focus more on the following. Once we have this, maybe a simpler solution would be be to tell AI crawlers to crawl `.md` instead of crawling the HTML (if it's possible?).
- https://github.com/brillout/docpress/issues/154

See also the `Discussion with Claude` link in #154 which explains how AI parses HTML.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.