Skip to content

Commit

Permalink
Added developer manual and instructions for documentation.
Browse files Browse the repository at this point in the history
Refs #3 and idaholab#156.
  • Loading branch information
cbolisetti committed Sep 10, 2018
1 parent 0ba7b3d commit b69be20
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Renderer:
Theory: manuals/theory/index.md
Software Quality: sqa/index.md
User: manuals/user/index.md
Developer: manuals/developer/index.md
Documentation:
Syntax: syntax/index.md
Help:
Expand Down
3 changes: 3 additions & 0 deletions doc/content/manuals/developer/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Developer Manual

!include include/developer/documentation.md
58 changes: 58 additions & 0 deletions doc/content/manuals/include/developer/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
## Instructions for documentation

Prior to merging the code, MOOSE and MASTODON require adequate documentation
describing the implemented feature, such as materials, post processors, etc.
Several tools are available for MOOSE-based documentation, and these tools are
described [here](utilities/MooseDocs/index.md).
For each new feature, the following documentation files are required.

#### Documentation of C++ objects

For each C++ object created, the developer should include the documentation as
prescribed by [MOOSE requirements](utilities/MooseDocs/generate.md).

#### User manual

For each feature (such as material, boundary condition, etc., which may include
one of more C++ objects), the developer must create one documentation file that
describes the method of usage of this feature. This file must be named as
`<feature_name>-user.md` and be placed in the appropriate sub folder in
`content/manuals/include`. A rough template for the user manual document is
below.

```
# <Name of the feature, e.g., lead-rubber isolator>
Introduction and link to the corresponding theory manual document.
Objects needed to simulate this feature. Links to the documentation of these
objects.
Associated actions, and usage in the Mastodon block, if available. Link to the
documentation of the corresponding Mastodon block action.
Quick demo of this feature including listings of input files and sample results.
```

#### Theory manual

For each feature (such as material, boundary condition, etc., which may include
one of more C++ objects), the developer must create one documentation file that
describes the theory behind this feature. This file must be named as
`<feature_name>-theory.md` and be placed in the appropriate sub folder in
`content/manuals/include`. A rough template for the theory manual document is
below.

```
# <Name of the feature, e.g., lead-rubber isolator>
Introduction about what the feature does and a link to the corresponding user
manual document.
Description of the physics, or the theory behind the feature including
references, equations, figures, etc.
Limitations, if any, of the implementation of this feature in MASTODON.
```

0 comments on commit b69be20

Please sign in to comment.