website-v2
website-v2 copied to clipboard
ScratchAddons
Consider Moving Docs to Docusaurus
Docusaurus is a industry-standard open-source docs platform that makes really good docs. Turbowarp uses it. The fact that ScratchTools has better docs than us can be attributed to it too. It still works with the github format, just instead of rolling our own docs we can use a proper docs setup. It comes with added benefits like search.
cc @Hans5958
Search would be nice. And I'm not convinced about having the user-facing FAQ and docs for developers all in one system...
MkDocs, Docusaurus, etc are good, but then you would either (a) rework it to have the same style, which is a little bit difficult, or (b) drop everything and have different style, at least we got the goodies of a docs.
Speaking about SPA, having Docusaurus would mean a bigger overhead, since it uses React, compared to non-SPA solutions like Hugo, MkDocs, which is still traditional. At that point, a full-fledged rewrite using Vue may be considered.
Search can be implemented with a little bit of work (#168).
PS. This has been on my mind for a while, but I also wanted to have separate docs and blog repo, but who knows?
Docusaurus and MKDocs are both great. Docusaurus feels a little more user friendly and MKDocs feels more like internal technical docs.
If we add search, we should restrict it to developer docs only, or somehow add a toggle for that. I hate it when I go to a Chrome extensions API doc, such as https://developer.chrome.com/docs/extensions/reference/storage/, then I try to use the search bar and it searches the whole Chrome docs, not just Chrome extensions.
There's already an old repo for this but it hasn't been touched in a while: https://github.com/scratchaddons/docs.
Correct. This is the proof-of-concept made by @GrahamSH-LLK for this issue, though it seems it is pretty abandoned at this point.