Skip to content

CONTRIBUTING

You can edit any page on GitHub or your favorite text program, but for the best preview use Obsidian

For a quick edit, the easiest is to edit on GitHub.

  • On the site, every page has a edit pencil in the top right corner linking to the file.
  • just click edit, do your changes and submit for PR

Setup in Obsidian¶

Edit these public notes in Obsidian

  • fork & clone the repo
  • open the local repo as a new vault in obsidian
  • edit files …
  • commit to git manually, or get the obsidian git plugin
  • create a PR from your fork

My private setup:

  • setup a private vault
  • create a submodule in your private vault
  • get the obsidian git plugin, and in options: enable update submodules

Markdown wikilink aren’t supported by GitHub preview, but are heavily used in Obsidian & other wiki apps. The site theme supports conversion, so please use wikilinks in all files, except files meant to be read on GitHub like the [[public-brain/### Public notes about game dev & anything else]]

Writing content¶

keep it short!
e.g. Compare the following:

When I was working on a plugin in Maya, I saw that adding ABC to the path did X.
In Maya, adding ABC to the path does X.