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.

Sign up for GitHub

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

Jump to bottom

[Docs] Implement search-index generation based on the DocsBuilder #492

Open
1 of 3 tasks
Luna-Klatzer opened this issue Jul 24, 2023 · 0 comments
Open
1 of 3 tasks

[Docs] Implement search-index generation based on the DocsBuilder #492

Luna-Klatzer opened this issue Jul 24, 2023 · 0 comments
Assignees
@Luna-Klatzer
Labels
docs Related to the project docs and info on the repo or website
Milestone
Improved Docs

Comments

@Luna-Klatzer
Copy link
Member

Is there an existing issue for this?

  • I have searched the existing issues

Current State & Issue

Implement automatic search-index generation during the build of the static documentation and API reference files.

This should replace the existing manual search index.

Expected Changes & Improvements

  • Implement automatic search index generation where a JSON file containing URL, title and description for every searchable page should be generated.
  • Restructure and update the search bar code to use the new search index.

Referenced sites
@Luna-Klatzer Luna-Klatzer added the docs Related to the project docs and info on the repo or website label Jul 24, 2023
@Luna-Klatzer Luna-Klatzer added this to the Improved Docs milestone Jul 24, 2023
@Luna-Klatzer Luna-Klatzer self-assigned this Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Luna-Klatzer Luna-Klatzer

Labels
docs Related to the project docs and info on the repo or website
Projects
Docs Development
Status: No status
Milestone
Improved Docs
Development

No branches or pull requests
1 participant
@Luna-Klatzer