Use Obsidian in Your Git Repo
Colocate your design docs next to your code
I’ve been talking with Annie about developing a video game together, and boy is she a firehouse of ideas! I told her to use Obsidian to write them down, not just for herself, but for me as a shared design doc I can follow along. She comes back to me the next day saying she got Obsidian, and she created the vault directly inside the git repo!
In that moment my brain realizes how brilliant this is; not just using Obsidian’s powerful featureset as a replacement for GitHub’s wiki or other 3rd party services, but colocating the documentation right next to the code. When I used Obsidian, I just put everything into one giant vault; all my game dev projects, daily journals, arts and crafts, writing, ideas, etc.
Funny thing is, this isn’t the first time I realized that keeping all project information in one place is useful.
Previously, I used Trello’s kanban board for storing ideas for my games and projects, and later I transitioned to using a kanban plugin in Obsidian to minimize my contact surface with 3rd party apps. I then realized I can use GitHub’s projects with its powerful UX to sort and label items and integrate directly with issues and pull requests!
In my short-sighted folly, I assumed GitHub wiki was the only choice, and I much prefered Obsidian with how powerful it was. I never thought to just, create the Obsidian vault inside the repo directly, in a docs folder at the root.
So thank you for that, Annie! And I hope this helps open the eyes of possibilities for others who read this, too ^^
Addendum
It would be super cool if Forgejo could have an integrated Obsidian vault viewer, or at least support internal wikilinks in markdown files. I’ll have to see how feasible it is to extend or modify Forgejo to implement such a feature, but I think a more universal browser extension would be great.
