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

Consider Moving Docs to Docusaurus #283

Open
GrahamSH-LLK opened this issue Dec 14, 2022 · 6 comments
Open

Consider Moving Docs to Docusaurus #283

GrahamSH-LLK opened this issue Dec 14, 2022 · 6 comments
Labels
scope: docs Related to the documentation (Scratch Addons Docs) scope: engine Related to the scripts and Hugo stuff of the website type: enhancement New feature or request

Comments

@GrahamSH-LLK
Copy link
Member

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.

@WorldLanguages
Copy link
Member

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...

@Hans5958
Copy link
Member

Hans5958 commented Dec 18, 2022

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?

@Hans5958 Hans5958 added type: enhancement New feature or request scope: docs Related to the documentation (Scratch Addons Docs) scope: engine Related to the scripts and Hugo stuff of the website labels Dec 18, 2022
@GrahamSH-LLK
Copy link
Member Author

Docusaurus and MKDocs are both great. Docusaurus feels a little more user friendly and MKDocs feels more like internal technical docs.

@WorldLanguages
Copy link
Member

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.

@Hans5958 Hans5958 added help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Jan 14, 2023
@Samq64
Copy link
Member

Samq64 commented Feb 9, 2024

There's already an old repo for this but it hasn't been touched in a while: https://github.com/scratchaddons/docs.

@Hans5958
Copy link
Member

Hans5958 commented Feb 9, 2024

Correct. This is the proof-of-concept made by @GrahamSH-LLK for this issue, though it seems it is pretty abandoned at this point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Related to the documentation (Scratch Addons Docs) scope: engine Related to the scripts and Hugo stuff of the website type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants