Searchable documentation #3238
-
I think a lot of developers would be happy, if the docs have some sort of search bar, to search for specific names, topics, etc. as the docs can be quite difficult to browse through when searching for specific information (in my case finding out, what the max file size is that a bot can upload and if it is influenced by the boost level) I hope this would be possible with whatever software you use to generate the docs. |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments
-
It is not currently possible with how we do documentation, which is a huge personal pain point. Our documentation is this repo of markdown files and a custom generator that turns it into react stuff for our dev portal. I very much want to also see this, but it will require a decent rewrite to our docs infrastructure. One day, I want it too :) |
Beta Was this translation helpful? Give feedback.
-
You guys could try using a software like mkdocs (which has a search bar O.O) instead. |
Beta Was this translation helpful? Give feedback.
-
Ye gods, yes please. I am lost going around in circles and circles in your documentation. Half the links lead to the deprecated SDK, which points me to the new one, where pursuing the answers I'm looking for leads back to the deprecated SDK... I am very frustrated. |
Beta Was this translation helpful? Give feedback.
-
Not to commit the cardinal sin of resurrecting a long-since-passed thread, but, I came to this repository to suggest this exact thing. I also do not know how the backend is structured, but perhaps something like docusaurus would work? It has versioned documentation, which would resolve the concerns of @JoeStrout (and many other users), provide search functionality (typically through Algolia although I'm sure there are alternatives), et cetera. |
Beta Was this translation helpful? Give feedback.
-
Now available docsearch3.mov |
Beta Was this translation helpful? Give feedback.
Now available
docsearch3.mov