Add blog post on Embed API v3 #144
Conversation
Co-authored-by: Manuel Kaufmann <[email protected]>
|
I'm thinking that I should add an animated gif here :) |
|
GIF, +1 |
|
🤖 Rendered result: https://readthedocs-blog--144.org.readthedocs.build/embed-api-v3/ |
There was a problem hiding this comment.
This is an OK first piece of copy, but I'd love to see more examples that show the value of the extension. If I'm a user, what is going to get me excited about using the extension? What cool features does it have? How do I start using it, is it easy?
I don't think the API responses are particularly interesting, since we aren't explaining the various arguments or how to query the various pieces of content. This feels like it goes half way in depth of showing the value of things, but I'd really like to either just point to more in depth guides for that content, or build it out more here to show why the API is interesting and the features it has.
We should be trying to sell the value of these tools to users way more, and talking less about deep technical details and justifications for our designs.
Co-authored-by: Eric Holscher <[email protected]>
|
Largely restructured the blog post, hopefully to make it more informative 👍🏽 |
| .. code-block:: | ||
| :caption: conf.py | ||
|
|
||
| hoverxref_auto_ref = True |
There was a problem hiding this comment.
I kinda hate that this is required. Is this not a reasonable default?
There was a problem hiding this comment.
Let's continue the conversation at readthedocs/sphinx-hoverxref#163. For sphinx-hoverxref 1.0.0, this is needed.
| but it is not yet available as a standalone library that can be reused | ||
| with standard frontend packaging tools. | ||
| If you would like to see this happening, | ||
| `let us know <https://github.com/readthedocs/sphinx-hoverxref/issues/>`_. |
|
Addressed comments, enabling automerge 👍🏽 |
No description provided.