CalvinBackup/erpnext
1
0
Fork 0
mirror of https://github.com/frappe/erpnext.git synced 2026-02-12 17:23:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update structure with more guidelines

Rucha Mahabal
2026-02-02 14:57:10 +05:30
parent 304a17ecd1
commit ef8f0ed494
1 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Page-format-for-ERPNext-docs.md → Page-format-for-ERPNext-HRMS-docs.md

@@ -18,7 +18,7 @@ Paragraph(s) which contain a brief introduction to the doctype, and what it's us
Add an example/scenario/use case to explain the feature.
(Navigation) To access Sales Order, go to:
> Home > Module Name > Section Name > Page Name
> Home > Module Name > Workspace Name > Page Name
## 1. Prerequisites (H2)
(add only where applicable, these will links)
@@ -99,12 +99,30 @@ Supplier names can be as mentioned below.
* Kirkland and Watkins Inc.
* Awesome Plastics Inc.
#### How to take screenshots?
Ensure your screenshots are clean and there's no cut off text.
For pointing out/highlighting buttons/areas use a sharp edged red box around it with the default red color on macOS #EE0000. Preferably use markdown style for linking images, it's just simpler: `![Image caption goes here](image path goes here)`.
> For screenshots/GIFs **Ensure** that you show the navigation part on the top left so that new users can quickly understand where the page is. Crop the screenshot so that there is only little padding width-wise, refer the [Item page](https://erpnext.com/docs/user/manual/en/stock/item).
> For screenshots/GIFs **Ensure** that you show the navigation part on the top left so that new users can quickly understand where the page is. Crop the screenshot so that there is only little padding width-wise, refer the [Item page](https://erpnext.com/docs/user/manual/en/stock/item).
#### Use American English everywhere
Use american english in docs (Customization, not Customisation)
#### Module-wise structure
The hierarchy could be Modules -> Workspaces -> Doctypes/Features, Reports, Tools, Settings
**Inside every module:**
Introduction
Setup
- Pages for masters - Item, Item Group
- 1 page for module implementation guidelines called "Getting Started"
Features
- could be sections with workspace names
- On every page: include Related topics, include link to tools for speeding the process
Settings
Reports
Tools