When you create a folder in Joggr, it has no relationship to a GitHub repository. We designed it this way so you can organize your GitHub documents into folders in Joggr, no matter where they are on GitHub.

For example, one of our customers had a ton of guides spread across different repositories, making them hard to find and manage without a deep knowledge of where things live in GitHub. With Joggr, they created a “Guides” folder and moved all their guides into it. This made it easy for their developers to find the right guide, no matter where it was on GitHub.

Yes, you can edit JoggrDocs in your IDE. JoggrDocs are converted to markdown (.md) and stored in your GitHub repositories. You can edit JoggrDocs in your IDE, GitHub, or Joggr.

Exception #1: Headers & Footers

When you create a JoggrDoc, Joggr adds a header and footer to the document. These additions to the markdown file are how Joggr tracks the document, so that Joggr knows if a document is out of date. Do NOT change or edit these sections or Joggr is unable to track and keep your document up to date.

Watch the video below to learn more.

Exception #2: Code Snippets

When you add a Code Snippet from your codebase using Joggr’s Code Explorer (Learn more about Code Snippets here), Joggr wraps the code snippet with a similar syntax as mentioned above. This is how Joggr tracks this code snippet, so that Joggr knows if it's is out of sync with your codebase. Do NOT change or edit a code snippet in your IDE or GitHub. If you need to change a code snippet, do this through Joggr's UI.

Watch the video below to learn more.

Yes, you can create create draft documents. You have two options:

1. Local Cache
2. Draft Pull Requests

Local Cache

Before you save to GitHub, all changes are saved to your local cache. Joggr empties the local cache as soon as you save to GitHub.

For example, let’s say you started a document, never saved to GitHub, then navigated away from Joggr. If you were to start a document, you will see that your original content from your first session is loaded.

Draft Pull Request

To create a Draft Pull Request, click the input box titled Create as a draft when you save. When selected, Joggr creates a Draft Pull Request in GitHub.

Watch the video below to learn about both options.

You may want to add more repositories to your workspace so that you can document code from these repositories.

In the top right corner, click on the Settings Icon, then click Integrations. On the GitHub panel, click Configure. This will redirect you to your GitHub settings to add more repositories.

In the top left corner of your JoggrDoc you should see a GitHub icon. This shows you where the JoggrDoc is stored in GitHub.

Joggr is built on top of Git and GitHub. Every JoggrDoc created is committed to GitHub as a markdown file. Therefore, you can manage the audit history just like you do with your codebase 😀.

To invite more team members, send them a link to Joggr (app.joggr.io) or click on the arrow icon, enter their email address, and click Send Invite. This will send them an invite link to their email. Watch the short video below to learn more.