Skip to content

Commit 2ebb2c6

Browse files
committed
feat(manual): add design and advanced
1 parent d729f5f commit 2ebb2c6

File tree

4 files changed

+17
-1
lines changed

4 files changed

+17
-1
lines changed

esdoc.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,13 @@
2424
"manual": {
2525
"asset": "./manual/asset",
2626
"overview": ["./manual/overview.md", "./manual/feature.md"],
27+
"design": ["./manual/design.md"],
2728
"installation": ["./manual/installation.md"],
28-
"usage": ["./manual/usage.md", "./manual/api.md"],
29+
"usage": ["./manual/usage.md"],
2930
"tutorial": ["./manual/tutorial.md"],
3031
"configuration": ["./manual/configuration.md"],
3132
"example": ["./manual/example.md"],
33+
"advanced": ["./manual/api.md"],
3234
"faq": ["./manual/faq.md"],
3335
"changelog": ["./CHANGELOG.md"]
3436
}

manual/design.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Design
2+
3+
## Concept
4+
tbd
5+
6+
## Architecture
7+
tbd
8+
9+
## Model
10+
tbd

src/Publisher/Builder/ManualDocBuilder.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,13 @@ export default class ManualDocBuilder extends DocBuilder {
5757
const m = this._config.manual;
5858
const manualConfig = [];
5959
if (m.overview) manualConfig.push({label: 'Overview', paths: m.overview});
60+
if (m.design) manualConfig.push({label: 'Design', paths: m.design});
6061
if (m.installation) manualConfig.push({label: 'Installation', paths: m.installation});
6162
if (m.tutorial) manualConfig.push({label: 'Tutorial', paths: m.tutorial});
6263
if (m.usage) manualConfig.push({label: 'Usage', paths: m.usage});
6364
if (m.configuration) manualConfig.push({label: 'Configuration', paths: m.configuration});
6465
if (m.example) manualConfig.push({label: 'Example', paths: m.example});
66+
if (m.advanced) manualConfig.push({label: 'Advanced', paths: m.advanced});
6567
manualConfig.push({label: 'Reference', fileName: 'identifiers.html', references: true});
6668
if (m.faq) manualConfig.push({label: 'FAQ', paths: m.faq});
6769
if (m.changelog) manualConfig.push({label: 'Changelog', paths: m.changelog});

src/Typedef/typedef.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@
2121
* @property {Object} [manual]
2222
* @property {string} manual.asset
2323
* @property {string[]} manual.overview
24+
* @property {string[]} manual.design
2425
* @property {string[]} manual.installation
2526
* @property {string[]} manual.usage
2627
* @property {string[]} manual.tutorial
2728
* @property {string[]} manual.configuration
2829
* @property {string[]} manual.example
30+
* @property {string[]} manual.advanced
2931
* @property {string[]} manual.faq
3032
* @property {string[]} manual.changelog
3133
* @property {Object} [experimentalProposal]

0 commit comments

Comments
 (0)