question: docs

[faretek1]

• We have the github wiki
• We have the automatic (but outdated) sphinx documentation
• I also just ported the wiki to mkdocs here

It may be helpful to centralize this a bit

We could:

• add a branch docs to the repository (and maybe publish to gh pages)
• use scratchapi.org (but it may be a better idea to host the docs on this repo for things like automated docs)
• fix up the sphinx documentation, and maybe try to combine it with the github wiki
• use mkdocs for automated docs (i haven't researched this)

It is also possible to sync the github wiki with a wiki/ directory using a github action, but this is also not recommended

[uukelele]

mkdocs looking very good

[faretek1]

mkdocs looking very good

mkdocs is actually being deprecated, and so mkdocs-material (the most popular theme for mkdocs) is in an end-of-life stage (it will receive maintainance for the next year or so). The creators of mkdocs material have made a similar tool called zensical which is very similar to the mkdocs-material workflow. If we are to use those docs, it would be a good idea to migrate to zensical.

[faretek1]

I think the docs should be published on https://scratchapi.org or <attach.scratchapi.org> and then https://timmccool.github.io/scratchattach would redirect to scratchapi. It would be a much nicer url. The scratchapi website is owned by @TheCommCraft

[TheCommCraft]

I think that attach.scratchapi.org is the better choice. scratchapi.org seems better suited to hold a documentation of the scratch api itself.

[uukelele]

...

mkdocs is actually being deprecated, and so mkdocs-material (the most popular theme for mkdocs) is in an end-of-life stage (it will receive maintainance for the next year or so). The creators of mkdocs material have made a similar tool called zensical which is very similar to the mkdocs-material workflow. If we are to use those docs, it would be a good idea to migrate to zensical.

mkdocs 1.x is being deprecated because they are updating to 2.x (i read the blog post as one of my docs with mkdocs-material showed the warning with a link to it)

i think it is safe to stay on 1.x for a while before migrating, it's not high priority

[uukelele]

I think that attach.scratchapi.org is the better choice.

Or maybe sa.scratchapi.org