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

add overlay in https://readthedocs.io/ #43

Open
jossef opened this issue Mar 22, 2023 · 4 comments
Open

add overlay in https://readthedocs.io/ #43

jossef opened this issue Mar 22, 2023 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers integration Issues regarding adding new integrations

Comments

@jossef
Copy link
Member

jossef commented Mar 22, 2023

There are two types of adding Overlay to ReadTheDocs:

  1. Identifying the current page and adding the Overlay details as we do in npm.org and PyPI.
  2. Find links to ReadTheDocs on other websites and add the indicator to them.

For those two options, we need first to collect examples of both, then do some research to understand what you said about different package ecosystems, different URLs, different page structures, and so on.

@baruchiro
Copy link
Collaborator

Part of #14

@baruchiro baruchiro added enhancement New feature or request good first issue Good for newcomers integration Issues regarding adding new integrations labels Jun 4, 2023
@baruchiro
Copy link
Collaborator

DoD: Add to the README

@Oferlis
Copy link
Contributor

Oferlis commented Jun 7, 2023

Hey,
I am trying to tackle this one, but readthedocs package pages may be npm/pypi.
The current flow as I get it takes the type (npm/pypi) but it is not always shown in readthedocs URLs.

Any suggestions?

@baruchiro
Copy link
Collaborator

@Oferlis This issue is not described well.

There are two types of adding Overlay to ReadTheDocs:

  1. Identifying the current page and adding the Overlay details as we do in npm.org and PyPI.
  2. Find links to ReadTheDocs on other websites and add the indicator to them.

For those two options, we need first to collect examples of both, then do some research to understand what you said about different package ecosystems, different URLs, different page structures, and so on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers integration Issues regarding adding new integrations
Projects
None yet
Development

No branches or pull requests

4 participants