FAQs
Below are answers to some common questions about the Joggr platform & documentation.
How do Joggr folders relate to GitHub documents?
Folders in Joggr are independent of GitHub repositories. This lets you organize GitHub documents into folders, no matter where they are stored.
For example, a customer with guides scattered across multiple repositories used Joggr to create a “Guides” folder, making it easy for developers to find the right guide without searching through GitHub.
Can I edit JoggrDocs in my IDE?
Yes, you can edit JoggrDocs in your IDE. They are saved as markdown (.md) in GitHub and can be edited in your IDE, GitHub, or Joggr.
There are several exceptions to this, read below to learn more.
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.
Can I save JoggrDocs as drafts?
Yes, you can create create draft documents. You have two options:
- Local Cache
- Draft Pull Requests
We recommend you use Draft Pull Requests, so if your local cache is emptied you do not lose your work.
Local Cache
Before saving to GitHub, changes are stored locally. The cache clears once you save. If you leave without saving, your draft reloads when you return.
Draft Pull Request
To create a Draft Pull Request, check “Create as a draft” when saving. Joggr will then create it in GitHub.
Watch the video below to learn about both options.
How do I add more repositories?
To document code from more repositories, go to Settings > Integrations, then click Configure in the GitHub panel. This redirects you to GitHub to add repositories.
If you do not have access to add more repositories, reach out to your GitHub administrator.
How can I find my JoggrDoc in GitHub?
The GitHub icon in the top left of your JoggrDoc shows where it’s stored in GitHub.
How can I track changes to a JoggrDoc?
Joggr runs on Git and GitHub, saving each JoggrDoc as a markdown file. You can track history just like your code! 😃
How do I invite more team members?
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.
Have a question that isn’t on the list? Reach out in slack or send us a note at support@joggr.io.