docs: Add copy for LLMs and view as markdown buttons #1803
Conversation
|
Preview for this PR was built for commit |
|
Do we need those button on |
|
I think we can remove it from |
patrikbraborec
requested review from
fnesveda,
honzajavorek and
janbuchar
as code owners
patrikbraborec
force-pushed
the
docs/llms-buttons
branch
from
c366bc0 to
f7c75f4
Compare
|
In the last update, I added:
|
|
Preview for this PR was built for commit |
Bugbot found 1 bugTo see it, have a team admin activate your membership in the Cursor dashboard. |
|
Preview for this PR was built for commit |
There was a problem hiding this comment.
Thanks for catching redundant H1!
Regarding the buttons:
- they look good but on API docs they seem to float above the whole text instead of being under the title
* Also we have those pages that aggregate all endpoints within a section like [this page here](https://docs.apify.com/api/v2/actors), and I'm not sure if they are needed here
Interestingly enough, they are placed correctly here
|
Preview for this PR was built for commit |
|
I fixed the |
|
Would be cool to have some description in the PR. Hard to do a review when I don't know what I'm looking at 😅 |
There was a problem hiding this comment.
i guess we can leave it like this. i'd personally just patch the plugin (which we already do) to add the buttons directly (you can modify the files directly in node_modules and use patch-package to apply the changes on postinstall). there is one trick you can use so the imports are not necessary:
https://docusaurus.io/docs/markdown-features/react#mdx-component-scope
given a lot of those changes are about the imports, maybe using the global scope for that would make sense, to reduce the length of this
There was a problem hiding this comment.
Also, one more thing - I noticed that now the markdown files contain some weird characters that they didn't have before, e.g. here:
https://pr-1803.preview.docs.apify.com/platform/actors.md
|
Preview for this PR was built for commit |
Bugbot found 2 bugsTo see them, have a team admin activate your membership in the Cursor dashboard. |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
Co-authored-by: František Nesveda <fnesveda@users.noreply.github.com>
Co-authored-by: František Nesveda <fnesveda@users.noreply.github.com>
patrikbraborec
force-pushed
the
docs/llms-buttons
branch
from
c60a725 to
86f42b6
Compare
Bugbot found 1 bugTo see it, have a team admin activate your membership in the Cursor dashboard. |
|
Preview for this PR was built for commit |
Fix issues with content template
patrikbraborec
force-pushed
the
docs/llms-buttons
branch
from
86f42b6 to
f162354
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Hi @fnesveda, thanks for the review and suggestions. I fixed all your comments, but unfortunately I wasn't able to fix the one with weird characters (see the image). In the end, I found that the issue is caused by something else because I tried to create an empty PR #1819, and you can see the issue there as well. Interestingly enough, if you check production, it works correctly. So maybe it's something with the preview environment? Anyway, if it's OK with you, I would merge this PR and tackle the issue in a separate PR. cc. @HonzaTuron, you can check the function that removes LLM buttons from 
|
|
@patrikbraborec @fnesveda Regarding weird characters, when you download markdown file and open it in normal editor, it shows zero width space. 
So I believe this is an issue of browser rendering which trying to render some HTML element instead. |
Oh wow, interesting. I've looked into it quickly, and it looks like the weird characters are zero-width spaces, and Docusaurus is adding them into the links so that they would display at all: facebook/docusaurus#5990. They're present in both the production and preview docs, but on production, the
Yep, agreed. IMHO easiest would be to have some post-processing step which runs a search&replace on the built |
Co-authored-by: František Nesveda <fnesveda@users.noreply.github.com>
7 participants
A draft for "LLM buttons" in our docs.
It allows you to:
I call it a draft because it needs to be tested more properly as I edited layout files, and it would be also good to add to ALL docs pages (so far it works only on the academy and platform pages).