Skip to content
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

Guide for Embed API #7089

Merged
merged 6 commits into from May 18, 2020
Merged

Guide for Embed API #7089

merged 6 commits into from May 18, 2020

Conversation

humitos
Copy link
Member

@humitos humitos commented May 18, 2020

Document two different use cases for the Embed API.

My goals with this PR are:

  • communicate that Embed API exists
  • show two different ways of usage with real examples
  • let the user know that they can build something new on top of it
  • promote sphinx-hoverxref
  • have clickable working examples

I'm not mentioned https://github.com/agjohnson/readthedocs-client-js because I think it needs more work or at least a review and testing that it's still working. I think it makes sense to just mention and AJAX call for now and then we can update this page when we have polished our readthedocs-client-js.

Rendered version https://docs--7089.org.readthedocs.build/en/7089/guides/embedding-content.html

Document two different use cases for the Embed API.
@humitos humitos requested a review from May 18, 2020
@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 18, 2020

How does this compare to #7000?

@humitos
Copy link
Member Author

@humitos humitos commented May 18, 2020

Haha, I totally forgot about that PR 😄. However, I'd avoid mentioning our JS client for now (as #7000 does) since we haven't touched or polished yet. Besides, I think this guide is more complete, IMHO.

Please, take a look at this and let me know which you prefer.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 18, 2020

I've pushed some updates here. I moved the hoverxref section up since it's the most functional for users. I found the screenshot I found really confusing. I'd crop it more. I reduced the width, since I got confused when reading the page and thought it was the actual page content. The hover also looks like it's coming from the code sample, which was really confusing.

@humitos
Copy link
Member Author

@humitos humitos commented May 18, 2020

I changed the image using one from our own documentation and centered it. I think it looks more differentiated from the page's content itself and better because the tooltip is nicer :)

Copy link
Member

@ericholscher ericholscher left a comment

We should also add documentation for the embed API to the v2 public API docs, but this is fine for a first step I think.

@ericholscher ericholscher merged commit 96140c8 into master May 18, 2020
2 checks passed
@ericholscher ericholscher deleted the humitos/embed-docs branch May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants