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 search to published doc #1232

Open
shalper opened this issue Nov 4, 2024 · 3 comments
Open

Add search to published doc #1232

shalper opened this issue Nov 4, 2024 · 3 comments

Comments

@shalper
Copy link

shalper commented Nov 4, 2024

There are many plugins available to introduce search and AI support -

  1. Algolia
  2. Inkeep

Anything would help. It's currently very difficult to read through the doc without a search functionality.

@lehors
Copy link
Member

lehors commented Nov 4, 2024

Thanks for the suggestion. Do you know about the "one page view" though? You get the whole spec one single page, making it easy to search through it:
https://slsa.dev/spec/draft/onepage

It's accessible through the entry at the very end of the navigation menu. It should probably be more prominently displayed though.

@shalper
Copy link
Author

shalper commented Nov 5, 2024

Thanks @lehors for the clarification. I did see the option to switch to single page view, but I don't think it replaces the need for search within the doc.

@lehors
Copy link
Member

lehors commented Nov 5, 2024

So, to be clear, I wasn't trying to say that it wouldn't be a good idea to add a search function to the site, I was just trying to suggest a way to search through the spec. Are you saying that the ability to use the browser's find function in the single page view doesn't respond to the need to search through the spec?

I'm just trying to understand what the need really is.

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants