slsa-framework / slsa

Supply-chain Levels for Software Artifacts
https://slsa.dev
Other
1.55k stars 225 forks source link

Add search to published doc #1232

Open shalper opened 3 days ago

shalper commented 3 days ago

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 commented 3 days ago

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 commented 3 days ago

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 commented 2 days ago

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.