OSS documents (GitHub integration)
You can publish documentation for open source software (OSS) outside your plan's document slots. When you link a public GitHub repository that you maintain to a document, the document becomes an OSS document.
What changes for OSS documents
| Item | OSS document |
|---|---|
| Document slots | Does not count toward your plan's document slots. Up to 3 OSS documents per organization. |
| Custom domain and Google Analytics | Available on any plan (including the Free plan). |
| AI answers | Up to 1,000 answers per month for all OSS documents combined, separate from your organization's AI answers. Unlimited for BYOK and Enterprise organizations. |
| Access restrictions | Not available. OSS documents are meant to be readable by anyone. |
| "Powered by Monjiro" | Shown on the public site on any plan. |
Other limits, such as the number of members, follow your organization's plan.
Requirements for linking
- The repository is public.
- The person linking it is a maintainer of the repository (Admin or Maintain role).
- One repository can be linked to a document. The same repository cannot be linked to another document.
- Documents with access restrictions cannot be linked. Remove the access restrictions first.
- Archived documents cannot be linked.
Monjiro checks these requirements on GitHub when you link a repository. Your GitHub token (access permission) is not stored.
Link a repository
- Open the document's editor.
- Open the "Settings" tab in the right panel, and under "Integrations", click "Link" in the "GitHub integration" row.
- In the window that opens, enter the repository as owner/repository (for example, kairo-inc/example) and click "Verify on GitHub and link".
- GitHub opens. Review the permission requested by Monjiro and authorize it.
- You return to the editor and the result is shown. Once linked, the repository name appears in the "GitHub integration" row.
- If linking fails: The reason is shown (for example, the repository was not found, is not public, you are not a maintainer, it is already linked to another document, or the OSS document limit has been reached).
- To switch to another repository: Click "Change" in the "GitHub integration" row, enter the new repository and link it again.
Unlink a repository
- In the "Settings" tab of the right panel, click "Change" in the "GitHub integration" row.
- Click "Unlink".
When you unlink the repository, the document becomes a regular document and counts toward your plan's document slots. If no document slot is free, it cannot be unlinked. Archive another document or add slots first. For slots, see Pricing plans.
FAQ
Can I use OSS documents on a paid plan?
Yes. On any plan, up to 3 documents per organization can be OSS documents. OSS documents do not count toward your plan's document slots.
What happens when OSS documents receive more than 1,000 AI answers in a month?
For the rest of that month, the AI chat of OSS documents cannot answer. Your organization's AI answers and AI credits are not used. It can answer again from the next month.
Does the number of members increase?
No. The member limit follows your organization's plan.