ERPNext.com Frappe Cloud Support Partners Foundation Frappe School

New Documentation Website / Wiki

Hi Community,

Over the past few weeks, we have been working on a new documentation website that simplifies the contribution process and has a newer look and feel.

A few minutes back we have pointed docs.erpnext.com to this new site.

The GitHub repository is archived and the new contribution guidelines are here.

How to Contribute

Broadly the steps to make a change to the documentation is as follows

  1. Go to the page on which you want to make changes
  2. At the bottom of the page you will find the edit button
  3. On clicking the Edit button you should see a UI like this
  4. Now you can edit the markdown code and check the preview on the Preview Tab
  5. If you do not want to edit markdown and want to edit via the WYSIWYG Editor click on the switcher and choose Rich-Text
  6. For uploading images:
  7. In Markdown mode
    1. Click on add attachment button to upload an image
    2. Use the copy link button to get the link copied
    3. Then paste the link in the editor to display the image
  8. In WYSIWYG editor:
    1. You can either paste a copied image
    2. Drag and drop an image
    3. Use the image button on top of the editor
  9. After editing the file click on the Submit button and wait for your changes to get submitted
  10. Once submitted you will see this screen
  11. 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
  12. You can click on open contribution to continue your work or use the comment system to communicate with the reviewer
  13. 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 then is similar to editing
  14. 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!

33 Likes

Noticed it in the morning. Looks lovely!
Thank you team :heart:

2 Likes

Kudos to the team for the new website! Seems like the daily limit of the frappe cloud has been reached, please upgrade the limit :slight_smile:

Also, the documentation link from ‘Help’ button in the ERPNext desk view doesn’t work. Please update that too. @Mohammad_Hasnain

1 Like

Fixed

1 Like

This is awesome !! Very well organized too… Excellent work !!

1 Like

FYI it seems like the “Documentation” link at the very bottom of https://erpnext.com is broken as well after this change was published.

erpnext.org > ERPNext > User Manual does not find that new location yet correctly

Fixed

Fixed

2 Likes

This is awesome work that went into developing this new documentation site. Is the app that was used to develop it going to be open sourced? Would be interested in using it internally for our documentation.

1 Like

The app will be open-sourced and available here in near future: https://github.com/frappe/wiki star/watch it for updates :smile:

2 Likes

Hi @mwogi ,

The app is available here, the site is running on a branch from which this PR is raised. The PR will be merged soon(cleaning up some stuff) and then the app would be released.

4 Likes

@Mohammad_Hasnain Thank you very much! Great work indeed.

2 Likes

Some issues with the width adjustment. Please do check.

NICE!!!
Will defiantly contribute…

1 Like

Really amazing work :tada:

Looks like the active sidebar item width is affecting the main content width, will look into it

1 Like