What is Frappe Wiki

Frappe Wiki is an open-source app for wikis and documentation. It runs on the Frappe Framework, next to the other Frappe apps on your site. People sign in with their account on the site.

You use Frappe Wiki for product guides, help centers, company handbooks and team notes. Writers work in the app. Readers read the published pages on your site.

The main parts

• Spaces hold the pages of one wiki, such as a product guide or a handbook. Each space has its own URL, look and access rules. See Create a space.
• Pages are written in a rich text editor. You can add callouts, images, diagrams, PDFs and videos, and group pages in a tree. See Edit a page.
• Change requests collect your edits. A reviewer approves them before they go live. See What is a change request.
• Access is set per space. A space can be public, open to all signed-in users, or private to some roles. See Who can read and write.
• The reader shows published pages with a page tree, search and light or dark mode. See Browse a space.
• Analytics show page views, referrers and reader feedback. See Page views.
• GitHub sync keeps a space in step with a folder of Markdown files in a repository. See Connect a repository.
• SEO and AI readiness cover meta tags, social cards, a sitemap, a Markdown copy of every page and llms.txt. See Meta tags and Markdown and llms.txt.

How a change goes live

1. You click Edit on a page and give your change a title. Frappe Wiki starts a change request.
2. You edit pages. The editor saves your edits to the change request as you type.
3. You submit the change request for review.
4. A reviewer reads the changes and approves them.
5. A user with write access merges the change request. The pages go live.

Each merge adds a version to the page history. See Page history.

Next steps

• Install Frappe Wiki
• Find your way around
• Roles and permissions
• Quick start: Create a space