Skip to content

[Documentation]: Highlight API changes #31159

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

Open
jonniebigodes opened this issue Apr 17, 2025 · 3 comments · May be fixed by #31206
Open

[Documentation]: Highlight API changes #31159

jonniebigodes opened this issue Apr 17, 2025 · 3 comments · May be fixed by #31206
Assignees

Comments

@jonniebigodes
Copy link
Contributor

Describe the problem

Related to #30894

The upcoming release will restructure the Highlight module and change the API. Therefore, the documentation should be updated accordingly to reflect the changes.

What needs to happen:

  • Update the documentation to reflect the changes in the Highlight module
  • Remove any examples or references to the old API
  • Add examples for the new API
  • Adjust the migration guide to reflect the changes in the Highlight module

Additional context

No response

@kylegach
Copy link
Contributor

I think this was handled in #31148.

@jonniebigodes
Copy link
Contributor Author

Per @ghengeveld's pr and comment, the API changed a bit. Hence, I created it and am going to re-open it and leave it assigned to me. I want to test it out once it's added to the alpha/beta (wherever this lands).

@jonniebigodes jonniebigodes reopened this Apr 21, 2025
@ghengeveld
Copy link
Member

That's right, the highlights API has (significantly) changed since @jonniebigodes' previous PR. That one was mostly about it becoming a core module instead of an addon. The work done in #30894 is much more elaborate. The PR description contains details about the new API.

@kylegach kylegach linked a pull request Apr 28, 2025 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants