Updated Page format for ERPNext docs (markdown)

Prasad Ramesh
2019-07-09 20:39:54 +05:30
parent 1cd699918b
commit 36204674b1

@@ -1,16 +1,25 @@
# Sample DocType (DocType name, H1)
This section will contain a brief introduction to the doctype, what it is, where it is used etc.
A one line definition explaining the master/transaction.
Paragraph(s) which contain a brief introduction to the doctype, and what it's used for.
Navigation- To access Item master. go to:
> Home > Module Name > Section Name > Page Name
## 1. How to create Sample (H2)
This section will contain the steps to create the item.
1. **Module Name > Section Name > Page Name > New** (in bold).
2. Enter xyz/ select abc in this field (mandatory fields) with basic explanation of the fields.
1. Go to the <Page Name> list, click on New.
1. Enter xyz/ select abc in this field (mandatory fields) with basic explanation of the fields.
1. Save/Submit both. (Note that only transactions are submittable documents, masters can only be saved)
### 1.1 Sub-section for alternate ways to create. (H3)
There are multiple ways to create certain doctypes, add subsections for those alternate methods.
### 1.2 Sub-section for any other details
There may be additional fields/checkboxes that aren't necessarily a part of 'features', list them here.
## 2. Features (H2)
### 2.1 Feature 1 (H3)
### 2.2 Feature 1 (H3)
@@ -18,9 +27,10 @@ There are multiple ways to create certain doctypes, add subsections for those al
These sub sections will list out the various features a doctype offers other than the mandatory fields required to save the doctype. These are usually seen under different sections below the first set of fields and can be expanded by clicking on them. For example: some additional fields/features for the Item doctype would be: Description, Inventory, Auto Re-order etc.
## 3. Settings pages (H2)
A page would usually contain only two main sections, 1. How to Create and 2. Features. But for settings pages like [Buying settings](https://erpnext.com/docs/user/manual/en/buying/buying-settings), this doesn't apply and the settings can be listed as 1. abc 2. def. The actual settings will then be the subsections of these).
A page would usually contain only two main sections, 1. How to Create and 2. Features. But for settings pages like [Buying settings](https://erpnext.com/docs/user/manual/en/buying/buying-settings), this doesn't apply and the settings can be listed as 3.1 abc, 3.2 def, 3.3 xyz, etc. The actual group of settings will then be the subsections in these).
> Tip: Indent an image/paragraph by 4 spaces to continue a numbered list below it.
> Tip: Indent an image/paragraph by 4 spaces / a tab to continue a numbered list below it.
> To link to a specific heading, the link should be like this: /docs/user/manual/en/stock/item#26-serial-numbers-and-batches
### 4. Related Topics (H3)
1. This will be a list of related topics from the manual.
@@ -30,6 +40,6 @@ A page would usually contain only two main sections, 1. How to Create and 2. Fea
> Example: https://erpnext.com/docs/user/manual/en/stock/item
**Note:** Ensure your screenshots are clean and there's no cut off text.
For pointing out/highlighting buttons/areas use a red box around it with the default red color on macOS #EE0000.
For pointing out/highlighting buttons/areas use a sharp edged red box around it with the default red color on macOS #EE0000. Use markdown style for linking images, it's just simpler: `![Image caption goes here](image path goes here)`.
**Ensure** that you show the navigation part on the top left so that new users can quickly understand where the page is.
**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 above.