Obsidian Documentation System¶
This is a documentation portfolio project. I designed and built a small, self-contained documentation system to demonstrate how I think about technical writing — not just the writing itself, but the decisions behind it: how content is structured, what gets automated, and why.
The system documents itself. The documentation you see on this site is the portfolio.
What This Project Demonstrates¶
- Documentation system thinking — how content types, folder structures, and metadata conventions work together to create something maintainable
- Information architecture — content grouped by purpose, with clear separation between what the system is and how it works
- Docs-as-code workflows — version control, CI/CD, and automated publishing as part of the documentation process
- Editorial judgment — deliberate choices about what to automate and what to keep manual
Where to Start¶
Design Decisions — why I chose these tools, this structure, and this approach. This is where the thinking is most visible.
System Architecture — what the system is made of and how the components connect, including a visual diagram of the full pipeline.
Workflows — how content moves from authoring to publication, and how automation supports the process.
Built With¶
Obsidian for authoring, MkDocs Material for publishing, GitHub Actions for CI/CD, and GitHub Pages for hosting. Python scripts handle indexing, timestamp maintenance, and AI-generated summaries.
About Me¶
I'm a former full-stack developer with seven years of experience in complex, domain-driven systems. I'm now focused on technical writing, documentation, and knowledge management — roles where communication, structure, and user understanding are central.