RoamJS / smartblocks

MIT License
24 stars 7 forks source link

Docs Migration to GitHub #83

Closed mdroidian closed 1 year ago

mdroidian commented 1 year ago

The Wiki is up as well to explore and get a feel for.

Initially I thought it could have been an option, but I'm leaning back towards /docs now based on your comments from today about having the docs updates in the same commit as the code as well some of the limitations of the wiki.

Negatives of Wiki

The negatives of /docs would be minor

We probably could create GH Actions to sync to the Wiki, but /docs only seems fine.

A couple things to look at in this draft:

ToDo

dvargas92495 commented 1 year ago

creating and maintaining an index ToC on all pages (if we want, I lean yes) creating and maintaining a footer on all pages (if we want, I lean no)

Both of these could also be mitigated via scripting

dvargas92495 commented 1 year ago

naming convention of files to keep order and allow for later insertions

This is pretty dope - would actually be a fan of doing this for samepage docs instead of the metadata.json files that currently exist there

mdroidian commented 1 year ago

Didn't npm version patch, will do with follow up PR

dvargas92495 commented 1 year ago

So dope - thanks for taking this on!

dvargas92495 commented 1 year ago

so dope - thanks for taking this on!