Skip to content

Commit 2352fe0

Browse files
Tit PetricTit Petric
Tit Petric
authored and
Tit Petric
committed
Add OAS docs
1 parent 749ea68 commit 2352fe0

File tree

2 files changed

+2681
-13
lines changed

2 files changed

+2681
-13
lines changed

docs/Taskfile.yml

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,19 @@ tasks:
1212
desc: "Generate documentation"
1313
aliases: [codegen, gen]
1414
cmds:
15-
- task: generate:internal
16-
- task: generate:plugin
15+
- task: generate:docs
1716
- task: fmt
1817

19-
generate:internal:
20-
internal: true
21-
desc: "Generate internal API godocs."
22-
cmds:
23-
- cd '{{.root}}/internal' && go-fsck docs ./... > ../docs/dev/internal.md
24-
25-
generate:plugin:
18+
generate:docs:
2619
internal: true
2720
desc: "Generate plugin API godocs."
2821
cmds:
29-
- cd '{{.root}}/ctx' && go-fsck docs . > ../docs/dev/plugin-apis.md && cd ..
30-
- cd '{{.root}}/user' && go-fsck docs . >> ../docs/dev/plugin-apis.md && cd ..
31-
- cd '{{.root}}/storage' && go-fsck docs . >> ../docs/dev/plugin-apis.md && cd ..
32-
- cd '{{.root}}/log' && go-fsck docs . >> ../docs/dev/plugin-apis.md && cd ..
22+
- cd '{{.root}}/internal' && go-fsck docs ./... > ../docs/dev/internal.md
23+
- cd '{{.root}}/apidef/oas' && go-fsck docs . > ../../docs/dev/oas-apis.md
24+
- cd '{{.root}}/ctx' && go-fsck docs . > ../docs/dev/plugin-apis.md
25+
- cd '{{.root}}/user' && go-fsck docs . >> ../docs/dev/plugin-apis.md
26+
- cd '{{.root}}/storage' && go-fsck docs . >> ../docs/dev/plugin-apis.md
27+
- cd '{{.root}}/log' && go-fsck docs . >> ../docs/dev/plugin-apis.md
3328

3429
fmt:
3530
desc: "Run mdox to format markdowns"

0 commit comments

Comments
 (0)