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

👀 are API docs retaining their searchability? #4949

Open
pepopowitz opened this issue Feb 6, 2025 · 0 comments
Open

👀 are API docs retaining their searchability? #4949

pepopowitz opened this issue Feb 6, 2025 · 0 comments
Assignees
Labels
kind/bug Issues related with bugs in the documentation

Comments

@pepopowitz
Copy link
Collaborator

This is a question more than an issue.

With #4799, we upgraded the plugin we use to emit API docs. This newer version of the plugin emits endpoint docs client-side only -- there is no useful content from the server on each page.

I don't have a link, but Google claims that it executes JavaScript when crawling for SEO, so theoretically, search results for our docs should not be impacted. It would be worthwhile to confirm in the future that this is the case.

@pepopowitz pepopowitz added the kind/bug Issues related with bugs in the documentation label Feb 6, 2025
@pepopowitz pepopowitz self-assigned this Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Issues related with bugs in the documentation
Projects
Status: 🆕 Inbox
Development

No branches or pull requests

1 participant