Contributing to Frappe Documentation

Frappe’s documentation is maintained through the Frappe Wiki, allowing community members to improve existing documentation or create new pages. Contributors can build their reputation by documenting features, fixing inaccuracies, and helping keep the documentation up to date.

Step 1: Sign In

Log in to your Frappe Docs account before making any documentation changes. Once authenticated, you can edit existing pages or create new ones.

Step 2: Edit an Existing Page

To edit a documentation page:

1. Open the page you want to update.
2. Scroll to the bottom of the page.
3. Click the ellipsis (…) menu.
4. Select Edit.

The page will open in the documentation editor, where you can modify its content before submitting your changes for review.

Editing Options

Markdown Editor

The Markdown editor allows you to edit documentation using Markdown syntax. It also includes a Preview tab so you can verify formatting before submitting your changes.

Rich Text (WYSIWYG) Editor

If you prefer not to write Markdown, switch to the Rich Text editor. This visual editor lets you format content without using Markdown syntax.

Uploading Images

In Markdown Mode

To insert images while using the Markdown editor:

1. Click Add Attachment.
2. Upload the required image.
3. Copy the generated image link.
4. Paste the link into your Markdown document to display the image.

In Rich Text Mode

The Rich Text editor offers multiple ways to insert images:

• Paste an image directly from your clipboard.
• Drag and drop an image into the editor.
• Use the toolbar’s image upload button.

Submitting Your Changes

After completing your edits, click the Submit button.

Your contribution enters the review process, where reviewers can:

• Approve the changes.
• Request modifications.
• Reject the submission if necessary.

You can monitor the status of your submission, continue editing if required, and communicate with reviewers through the built-in comment system.

Creating a New Documentation Page

If the documentation you need does not already exist, you can create a new page instead of editing an existing one.

1. 1. Open the documentation sidebar.
   2. Click New Page at the bottom of the sidebar.
   3. Create the page content.
   4. Submit it for review.

The review workflow is the same as editing an existing page.

Managing the Documentation Sidebar

When necessary, you can reorganize the documentation navigation by dragging and dropping sidebar items while creating or editing pages.

Only modify the sidebar structure when it improves documentation organization and navigation.