TShock icon indicating copy to clipboard operation
TShock copied to clipboard

Add Obsidian vault for docs rewrite

Open hakusaro opened this issue 4 years ago • 2 comments

Because Readme.io has been kinda scummy in terms of "giving us the features that we want" and because most wikis don't work well, I'm proposing a hybrid approach: an Obsidian vault (which is plain markdown) and having the contents published to Obsidian publish. The end result will be nice a nice and easily navigable website that can be used to reference TShock things without needing a separate interface to edit the docs for.

Plus we can integrate with CI, etc.

Major things to do:

  • [ ] Undo the changes to the dumper utilities so that plain markdown tables are generated
  • [ ] Ideally supply things like CI to alert if things need to be updated (changed permissions file? maybe you should possibly have re-run the dumper and updated the permissions docs?)
  • [ ] Get Obsidian publish and set it up
  • [ ] Manually transfer over pages worth keeping
  • [ ] Re-verify the protocol docs

hakusaro avatar Jun 06 '21 04:06 hakusaro

Looks like you added docs/.obsidian/* to the git ignore, but added and committed docs/.obsidian/config before then.

drunderscore avatar Jun 09 '21 12:06 drunderscore

@drunderscore yes, intentionally

hakusaro avatar Jun 09 '21 17:06 hakusaro