-
Notifications
You must be signed in to change notification settings - Fork 9.7k
[IMP] extensions: add copy to markdown button #13998
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
9896def
to
765962b
Compare
Add a "Copy to Markdown" button using Turndown to convert HTML docs to Markdown, with support for syntax-highlighted code blocks. This will allow an easier usage of LLM.
765962b
to
75d756a
Compare
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.
Hi, could you elaborate on the purpose of this PR and/or link a related task?
From the current "allow an easier usage of LLM" explanation, I assume that it'd be because LLMs digest Markdown more easily than HTML, but it's not clear at all to me why the translation should happen in JS rather than on a server, and why every user should now have a very confusing copy to md button.
Hello! Yes, this is something I’ve seen in other documentation systems and found very practical. |
Ok, I see. I thought it was meant for a specific project, like a RAG chatbot fetching information from the documentation, hence my suggestion to pre-process the information on the server. For a general-purpose "copy to clipboard and paste in chatbot prompt" usage, I'm sure that the current approach fits very well. It might be perfect for power users of other technical documentation, but our readers are primarily functional people and not that tech-savvy. WDYT @xpl-odoo @auva-odoo? |
I understand your point, potentially we could limit this feature to the dev docs only? |
Currently, I doubt it would be helpful for the average reader of the user's part of the documentation; the help chatbot should be enough in most cases. |
To be honest, I doubt this feature's usefulness would outweigh its maintenance cost in our dev docs. The information is scattered across a bazillion pages that all large LLMs have already digested thousands of times anyway. The per-page export and manually feeding limitations make me believe she should not go forward with this. |
Ok closing the PR then |
Add a "Copy to Markdown" button using Turndown to convert HTML docs to Markdown, with support for syntax-highlighted code blocks. This will allow an easier usage of LLM.
Here's how it look (copy button is next to version selector, right window show raw output and preview):
