Appearance

Obsidian Workflow Documentation ​

This exercise helps you set up a structured documentation workflow in Obsidian using a predefined GitHub template. You’ll create your project from the template, organize your vault with Templater and Daily Notes, add proper content to each section, and finally push everything to GitHub for versioned documentation.

Time: 25–35 minutes Deliverables: 6–7 screenshots (library, daily note, meeting note, workshop README, GitHub commit, repo view)

Step 1 — Create your project from the GitHub template ​

  • Open the template link: https://github.com/iitrabhi/project-template

  • Click Use this template → Create a new repository.

    • Name: avkalan-obsidian-workflow (or similar)
    • Choose visibility: Private or Public
    • Click Create repository

  • Clone your new repository using GitHub Desktop:

    • Go to File → Clone repository…
    • Select your new repo and choose a local folder

  • Open this cloned folder in Obsidian using Open folder as vault → Select the cloned repo folder

Screenshot A: Obsidian sidebar showing the full folder structure from the template (e.g., library, daily, meetings, 2_study, etc.)

Step 2 — Add initial notes to the Library folder ​

  • Inside 1_library/notes/, create three notes:

    • obsidian-setup.md — purpose and structure of your vault
    • tooling-index.md — short references to key tools (VS Code, Docker, FEniCS, etc.)
    • glossary.md — recurring terms and abbreviations

Screenshot B: Library folder expanded with obsidian-setup.md open in the editor.

Step 3 — Create a Daily Note using the sidebar and Templater ​

  • Enable the Daily Notes and Templater plugins (Core → enable, Community → install).
  • In the left sidebar, click the calendar or “Create new daily note” icon to generate today’s note automatically.
  • Run Templater → Insert template and choose your Daily Note template.
  • Fill it with your actual progress and link to related notes.

Screenshot C: Daily note created via sidebar + Templater showing real filled content and internal links.

Step 4 — Create a Meeting Note using Templater ​

  • Open the meetings/ folder → Create a new file.
  • Run Templater → Insert template → Meeting Note Template
  • Fill the note with real meeting content — agenda, decisions, and next steps

Screenshot D: Meeting note showing filled sections for agenda, decisions, and actions.

Step 5 — Create a README file in the 2_study/2_workshop folder ​

  • Navigate to 2_study/2_workshop/
  • Create a new subfolder named after your study.
  • Inside the subfolder, create a README.md file

Screenshot E: Workshop subfolder and README file open in Obsidian showing Study, Results, and Conclusions sections.

Step 6 — Commit and Push to GitHub ​

  • Open GitHub Desktop → ensure your repo is selected.
  • Stage all new files and folders.
  • Write a clear commit message:
  • Click Commit to main, then Push origin.
  • Open your repo on github.com and verify all folders and notes.

Screenshot F: GitHub repository page showing folders (library, daily, meetings, 2_study/2_workshop/) and your notes.

Acceptance Checklist (pass/fail) ​

  • Project created from https://github.com/iitrabhi/project-template
  • Vault opened in Obsidian and structure visible
  • Daily note created using Daily Notes sidebar icon + Templater
  • Meeting note created using Templater with all sections filled
  • Workshop subfolder created inside 2_study/2_workshop/ with structured README.md
  • Commit pushed to GitHub with a clear message and repo verified online

If your folder names or templates differ slightly, that’s fine — ensure your Daily, Meeting, and Workshop notes all follow structured documentation and link back to each other. This consistency ensures clarity, traceability, and professional-quality documentation for your technical studies.