Skip to content

Page format for ERPNext docs

Prasad Ramesh edited this page Mar 26, 2019 · 27 revisions

Sample (DocType name, H1)

This section will contain a brief introduction to the doctype, what it is, where it is used etc.

1. How to create Sample (H3)

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.1 Sub-section for alternate ways to create. (H4)

There multiple ways to create certain doctypes, add subsections for those alternate methods.

2. Features (H3)

2.1 Feature 1 (H4)

2.2 Feature 1 (H4)

...and so on. 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 when clicked on them. For example: some additional fields/features for the Item doctype would be: Description, Inventory, Auto Re-order etc.

3. Settings pages (H3)

A page would usually contain only two main sections, 1. How to Create and 2. Features. But for settings pages like Buying settings, this doesn't apply and the settings can be listed as 1. Fields(H3> and 2. Checkboxes(H3>. The actual settings will then be the subsections of these).

Tip: Indent an image/paragraph by 4 spaces to continue a numbered list below it.

4. Related Topics (H3)

  1. This will be a list of related topics from the manual.
  2. They can be links to other manual pages and links to other articles, same or different modules. For example: Selling, Buying, and Stock can have cross-related topics.
  3. Keep relevance in mind when adding an item in this section.
Clone this wiki locally