Contribute to Documentation for Frappe Apps

The documentation for Frappe Apps is maintained in Frappe Wiki. This allows each community member to contribute documentation of a new application or enhance the existing ones. Just like a Wiki community, there are editors and reviewers. As an individual, you can build your reputation by editing documentation for the new features and enhancements, till graduating to the reviewer's role.

Steps to contribute to the documentation

Before editing documentation, ensure to sign up. You can sign from

docs.sample.url/login

Once logged in, you will be able to see the option for editing existing doc pages.

Editing a Page

At the bottom of the page, click the ellipsis menu (...) and choose edit.

Markdown Editor

On clicking the Edit button, you should see a UI like this

Now you can edit the markdown code and check the preview on the `Preview Tab`

WYSIWYG Editor

If you do not want to edit markdown and want to edit via the WYSIWYG Editor, click on the switcher and choose Rich-Text

Uploading Media In Markdown

Step for uploading images in Markdown mode.

Click on the “add attachment” button to upload an image
Use the copy link button to get the link copied!
Then paste the link in the editor to display the image

In WYSIWYG editor

Step for uploading images in WYSIWYG mode

You can either paste a copied image
List item: Drag and drop an image
Use the image button on top of the editor

Submit a Doc

After editing the file, click on the Submit button and wait for your change to get submitted. Once submitted, you will see this screen

On this screen, you can track all your contributions and wait for a reviewer to review your changes and either approve, reject or request changes.

You can click on open contribution to continue your work or use the comment system to communicate with the reviewer.

Create a New Wiki Page

If you want to create a new page instead of editing a page, you will find the New Page link at the bottom of the Left Sidebar. The process is then similar to editing.

You can also drag and drop sidebars on the edit/ new page to rearrange them(Use this only when necessary)

Hoping to see lots of contributions!