-
Notifications
You must be signed in to change notification settings - Fork 340
Build documentation for LLMs #2917
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
https://68d644ca6f509ad95baa41de--pkgdown-dev.netlify.app/dev/llms.txt -- I wonder whether the preview workflow should gain the ability to set "" as an URL so that links in the preview would be to the preview. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Thanks for working on this!
About how long does this extra step take for pkgdown itself? (i.e. how much overhead does this add?)
Something is wrong with my benchmark: benchmark <- bench::mark(
{fs::dir_delete("docs");pkgdown::build_site(".", lazy = FALSE, preview = FALSE)},
{fs::dir_delete("docs");pkgdown::build_site(".", lazy = FALSE, preview = FALSE, override = list(template = list("build-md" = FALSE)))}
) then the median time is 1.3m for the former one, 1.18m for the latter one?! |
@maelle given the long duration, I'd just use |
I gave up on perfect footnotes. |
|
||
**deprecated** | ||
|
||
`intro`: “Get Started�, which links to a vignette or article with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not me getting encoding wrong 🫠
Do you want to add some tests for the individual convert functions, or should I? I think it'd be nice to get this into a release in the near future (e.g. early November?) |
|
Oh we should also decide on some top-level parameter to turn this off for folks who don't want it. How about this? llm-docs: false And then in the future if we figure out other needed params we can put them under there: llm-docs:
some-new-option: 1
some-other-option: foo |
Ah yes definitely important!! I like your suggestion. |
Annoyingly I couldn't reprex the issue I was seeing on the live stie
{{#subtitle}}<h3>{{{.}}}</h3>{{/subtitle}} | ||
{{#desc}}<div class="section-desc">{{{desc}}}</div>{{/desc}} | ||
|
||
{{#topics}}<dl> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@maelle we were accidentally generating a definition list for every definition 😬
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ouch!! 🙈
Fix #2914
MWE