spacemeshos / pm

Project management. Meta-tasks related to research, dev, and specs for the Spacemesh protocol and infrastructure.
http://spacemesh.io/
Creative Commons Zero v1.0 Universal
2 stars 0 forks source link

Choose tool/platform to host new docs #147

Closed lrettig closed 1 year ago

lrettig commented 1 year ago

Candidates:

CC @oriya, @yaelmhoffman, @AskalAl, @selfdual-brain

lrettig commented 1 year ago

Assuming we want to keep our homepage and blog separate, we should probably keep using docsify since it's dead simple, we don't need react or fancy customizability, etc. If OTOH we want to set up a single megasite, Docusaurus is probably the best choice.

yaelmhoffman commented 1 year ago

I've been playing around with Docusaurus to make a demo site, and I have to say that I like it a lot.

yaelmhoffman commented 1 year ago

While Docsify is definitely simpler, I think Docusaurus' default theme and layout looks a lot more professional.

yaelmhoffman commented 1 year ago

Here are some screenshots of the demo site I made using Docusaurus:

preview2 preview3

lrettig commented 1 year ago

Let's get a placeholder site up in the next day or two at docs.spacemesh.io or spacemesh.io/docs, set up placeholders for the 12 sections specified in the master plan, and begin fleshing it out. I can set this up as a new repository and give everyone access.

lrettig commented 1 year ago

@yaelmhoffman does this live in a repo now that I can take a look at?

yaelmhoffman commented 1 year ago

@yaelmhoffman does this live in a repo now that I can take a look at?

Yes. It's still private, but I've just added you as an admin: https://github.com/spacemeshos/docs

This is all preliminary and open to change. I just wanted a visual of what I had in mind for the overall documentation structure and organization.

lrettig commented 1 year ago

We've decided to go with docusaurus