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

Integrate the new addons flyout into the theme #1523

Closed
humitos opened this issue Sep 7, 2023 · 1 comment · Fixed by #1526
Closed

Integrate the new addons flyout into the theme #1523

humitos opened this issue Sep 7, 2023 · 1 comment · Fixed by #1526
Assignees
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@humitos
Copy link
Member

humitos commented Sep 7, 2023

We are working on a new addons flyout (https://github.com/readthedocs/addons) that emulates the old flyout shown at the bottom right for all the themes that are not Read the Docs Sphinx theme:

Screenshot_2023-09-07_13-47-21

However, for our own theme, we are nicely integrating it on the bottom left together with the navbar:

Screenshot_2023-09-07_13-48-22

So, we would use the integration points from the new addons to write <readthedocs-flyout></readthedocs-flyout> in the navbar of this theme (or using the JSON response) and display it integrated in the same way it currently is the old one.

@humitos humitos added Needed: design decision A core team decision is required Improvement Minor improvement to code labels Sep 7, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Sep 7, 2023
humitos added a commit that referenced this issue Sep 13, 2023
Initial experimentation to use the `CustomEvent` triggered by the addons called
`readthedocsdataready` event (from
readthedocs/addons#64) to build the Read the Docs
flyout being integrated into the theme keeping the original look & feel.

* Related: readthedocs/addons#64
* Closes #1523
@humitos humitos self-assigned this Sep 21, 2023
@ericholscher ericholscher moved this from Planned to In progress in 📍Roadmap Dec 6, 2023
@ericholscher ericholscher moved this from In progress to Needs review in 📍Roadmap Mar 27, 2024
@humitos humitos moved this from Needs review to In progress in 📍Roadmap Apr 8, 2024
@humitos humitos moved this from In progress to Needs review in 📍Roadmap Apr 15, 2024
@humitos
Copy link
Member Author

humitos commented Jun 3, 2024

We have been testing this in our own documentation for months now and it has been working fine. I haven't had any negative feedback about it, so I think we should be ready to move forward with discussing what are the next steps here.

@humitos humitos moved this from Needs review to In progress in 📍Roadmap Jun 6, 2024
@humitos humitos moved this from In progress to Needs review in 📍Roadmap Jun 25, 2024
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
Status: Done
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant