Mobile Workflow
Video walkthrough:
Mobile Obsidian + GitHub: Full Setup Walkthrough (for NadiKosh Contributors)
Section titled “Mobile Obsidian + GitHub: Full Setup Walkthrough (for NadiKosh Contributors)”This guide explains how to use the GitHub app and Obsidian on your mobile phone to create and edit Markdown files for the NadiKosh (kosh) repository.
You can follow this as a written companion to the video tutorial.
1. What You Need
Section titled “1. What You Need”Apps to install
Section titled “Apps to install”Install these two apps on your mobile:
- GitHub (official GitHub mobile app)
- Obsidian (note‑taking and Markdown editor)
Optional but recommended: connect a physical keyboard to your phone for easier typing.
Why GitHub?
Section titled “Why GitHub?”- Stores all NadiKosh content in one place
- Tracks every change (version control)
- Makes collaboration easy (branches, pull requests, reviews)
Why Obsidian?
Section titled “Why Obsidian?”- A powerful Markdown editor
- Simple mobile UI for writing
- Supports plugins (like Git integration) to sync with GitHub
- Great for structured writing and knowledge management
2. Getting Access to the NadiKosh Repo
Section titled “2. Getting Access to the NadiKosh Repo”2.1 Log in to GitHub app
Section titled “2.1 Log in to GitHub app”- Open the GitHub app.
- Log in to your account or sign up if you don’t have one.
2.2 Find and star the kosh repository
Section titled “2.2 Find and star the kosh repository”- In the GitHub app, use Search.
- Search for the organisation:
nadi-stuti. - Open the organisation and go to All repositories.
- Find the repo named
kosh. - Open it and tap Star.
2.3 Send your GitHub username
Section titled “2.3 Send your GitHub username”To become a collaborator:
- In the GitHub app, go to your profile to see your GitHub username.
- Send your username to us on our WhatsApp channel.
- Wait for an invitation to collaborate on the
koshrepo. - Accept the invitation from your GitHub inbox / email.
Once accepted, you will have permission to push changes and create pull requests.
3. First-Time Obsidian Setup (Mobile)
Section titled “3. First-Time Obsidian Setup (Mobile)”3.1 Open Obsidian as a new user
Section titled “3.1 Open Obsidian as a new user”- Open the Obsidian app.
- When it asks how to start:
- Create a new vault on your device.
- You can name it something like
NadiKoshor anything you prefer.
You will now be inside an empty vault.
3.2 Enable and install the Git plugin
Section titled “3.2 Enable and install the Git plugin”Obsidian supports many plugins that extend its power.
- Open Settings in Obsidian.
- Go to Community plugins.
- Turn on “Allow community plugins”.
- Tap Browse and search for “Obsidian Git”.
- Install and enable the Obsidian Git plugin.
Note: Obsidian has many useful plugins for writing. You can search the community plugins later to explore more tools that help with writing and organizing content.
4. Generate a GitHub Personal Access Token (PAT)
Section titled “4. Generate a GitHub Personal Access Token (PAT)”To let Obsidian Git talk to GitHub, you need a Personal Access Token.
4.1 Open GitHub in browser
Section titled “4.1 Open GitHub in browser”- Open your mobile browser.
- Go to:
https://github.com - Log in with the same account you used in the GitHub app.
4.2 Create a personal access token - classic
Section titled “4.2 Create a personal access token - classic”The exact UI may change over time, but generally:
- Go to your profile → Settings.
- Scroll down to Developer settings.
- Go to Personal access tokens (classic).
- Create a new token (for general use with repos).
- Give it:
- A name (for example:
obsidian-mobile). - Expiration (choose a reasonable duration).
- Public Repo access permissions (select the public_repo option from repo access).
- A name (for example:
- Generate the token.
- Copy and save:
- Your GitHub username
- Your email (used on GitHub)
- The personal access token
Keep your token secret. Treat it like a password.
5. Configure Obsidian Git Plugin
Section titled “5. Configure Obsidian Git Plugin”- In Obsidian, go to Settings → Community plugins → Obsidian Git (plugin settings).
- Fill in:
- Username: your GitHub username
- Email: the email used in your GitHub account
- Token: paste the personal access token you generated
Make sure these values are correct, otherwise Git operations will fail.
6. Clone the NadiKosh Repository into Obsidian
Section titled “6. Clone the NadiKosh Repository into Obsidian”You will now clone the kosh repo into your Obsidian vault.
6.1 Open command palette
Section titled “6.1 Open command palette”- In Obsidian, look for the hamburger menu at the bottom (three horizontal lines).
- Tap it to open the Command palette.
6.2 Clone the repo
Section titled “6.2 Clone the repo”- In the Command palette, search for the Obsidian Git clone command, for example: -
Git: Clone an existing remote repo - When asked for the repo URL, enter:
text https://github.com/nadi-stuti/kosh - When asked for folder name, use something like: nadikosh Obsidian will now clone the repo into your vault.
7. Branch Workflow: Always Work on a Separate Branch
Section titled “7. Branch Workflow: Always Work on a Separate Branch”You should never edit directly on the master branch. Always create a new branch from the latest master.
7.1 The 3‑step rule for every new branch
Section titled “7.1 The 3‑step rule for every new branch”Whenever you start a new piece of work:
- Switch to the master branch
- Pull the latest changes from remote
- Create a new branch for your work
7.2 Switching to master and pulling
Section titled “7.2 Switching to master and pulling”Use the Obsidian Git commands:
- Switch to the master branch (e.g.
Git: Checkout master). - Run pull (e.g.
Git: Pull).
If you get an error about missing name or email:
- Go back to Obsidian Git settings.
- Make sure username and email are correctly set (matching your GitHub account).
7.3 Create a new branch
Section titled “7.3 Create a new branch”After master is updated:
- From the command palette, run the create branch command (e.g.
Git: Create new branch). - Give the branch a clear name, for example:
ganga-research-update-01add-ganga-article-username
Make sure you are now on the new branch before editing any files.
8. Navigating to the Ganga Research Folder
Section titled “8. Navigating to the Ganga Research Folder”You will usually edit content inside the src folder of the repo.
- Switch to folder view in Obsidian.
- Navigate to:
src/content/docs/thinking-grounds/river-research/ganga
- Find the
gangafolder. - Long press on the
gangafolder. - Choose Create new note (or similar option).
This will create a new Markdown file inside the ganga folder.
9. Writing and Editing in Obsidian
Section titled “9. Writing and Editing in Obsidian”9.1 Add properties (frontmatter)
Section titled “9.1 Add properties (frontmatter)”- Open your new note.
- Scroll to the editing area.
- From the top‑right three dots, select Add property (or similar).
- Add the required metadata/properties (title & description)
9.2 Use editing tools
Section titled “9.2 Use editing tools”- Use the heading buttons to create titles and sections.
- Use bold, italic, lists, and other tools in the bottom toolbar.
- Structure your article clearly:
- Title
- Introduction
- Main sections (with headings)
- References or notes if needed
Write your content normally in Markdown.
10. Using Git Inside Obsidian (Stage, Commit, Sync)
Section titled “10. Using Git Inside Obsidian (Stage, Commit, Sync)”After you make some changes, you must save and then sync them to GitHub.
10.1 Open Git source control in Obsidian
Section titled “10.1 Open Git source control in Obsidian”- Tap the bottom hamburger menu.
- Open the Git source control view (Obsidian Git panel).
10.2 Refresh, stage, commit, sync
Section titled “10.2 Refresh, stage, commit, sync”- Tap the refresh icon to scan for changes.
- Use the
+(plus) button to stage all changed files. - Tap the tick (✔) button to commit your changes.
- Enter a clear commit message, e.g.
Add new Ganga research note.
- Enter a clear commit message, e.g.
- Tap the up arrow button to sync/push your commits to GitHub.
Your branch with changes is now on GitHub.
11. Create a Pull Request (PR) in GitHub App
Section titled “11. Create a Pull Request (PR) in GitHub App”Now you will open a PR so your changes can be reviewed and merged.
- Open the GitHub app.
- Navigate to the
nadi-stuti/koshrepository. - Switch to your feature branch (the one you created).
- Tap to create a New pull request.
- Fill in:
- Title: short summary of the change.
- Description: explain what you added/edited.
- Tap Create pull request.
11.1 Assign the PR
Section titled “11.1 Assign the PR”- In the PR view, set an assignee (who should review it), as defined by your team process.
12. Preview and Update Your Changes
Section titled “12. Preview and Update Your Changes”After the PR is created:
- Wait for the deployment/preview to be generated for the PR.
- Open the PR preview link to see how your article looks on the site.
- If something is wrong (formatting, content, etc.):
- Go back to Obsidian.
- Make changes in the same branch.
- Repeat the stage → commit → sync steps.
- The PR will update automatically with new commits.
You can push more changes to the same branch until everything looks good.
13. Quick Edits Directly in GitHub App
Section titled “13. Quick Edits Directly in GitHub App”For small and fast fixes (typos, small wording changes):
- Open the
koshrepo in the GitHub app. - Navigate to the file you want to edit.
- Use the edit option in GitHub to change the content.
- Commit the change directly from the app.
This is useful when you don’t want to open Obsidian for minor edits.
14. Keeping Your Master Branch Updated
Section titled “14. Keeping Your Master Branch Updated”To avoid conflicts and stay in sync:
-
Occasionally:
- Switch to the master branch in Obsidian Git.
- Run pull to update it with the latest changes.
-
Always:
- Create a new branch from the updated master before starting any new work.
This keeps your work clean and reduces merge issues.
15. Summary
Section titled “15. Summary”- Install GitHub and Obsidian on your mobile.
- Get collaboration access to the
nadi-stuti/koshrepo. - Use Obsidian Git with a personal access token for syncing.
- Always:
- Update master
- Create a new branch
- Edit inside the correct folder
- Stage → Commit → Sync
- Create a Pull Request from the GitHub app
- Use PR previews to check your article and push more commits if needed.
- For small edits, you can directly change files in the GitHub app.