Skip to content

Commit 8d86b30

Browse files
committed
first
1 parent 10a6e57 commit 8d86b30

File tree

4 files changed

+1308
-3
lines changed

4 files changed

+1308
-3
lines changed

.github/workflows/build_publish.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ jobs:
4646
- name: Install dependencies
4747
run: npm ci
4848
- name: Generate REST API docs
49-
run: docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate -i https://raw.githubusercontent.com/CoderBotOrg/backend/develop/coderbot/v1.yml -g markdown -o /local/docs/api_v1
49+
run: npm i -g widdershins
50+
run: widdershins ../backend/coderbot/v1.yml --lang Python -o docs/api.md https://raw.githubusercontent.com/CoderBotOrg/backend/develop/coderbot/v1.yml -o docs/api.md
5051
- name: Static HTML export with VitePress
5152
run: npm run docs:build
5253
- name: Upload artifact

docs/.vitepress/config.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ export default {
88
items: [
99
{ text: 'Description', link: '/Description' },
1010
{ text: 'Getting Started', link: '/Getting_started' },
11+
{ text: 'Deployment', link: '/Deployment' },
1112
{ text: 'Hardware Architecture', link: '/Hardware_Architecture' },
1213
{ text: 'Software Architecture', link: '/Software_Architecture' },
13-
{ text: 'Backend', link: '/Backend' },
14+
{ text: 'Backend API', link: '/api.md' },
1415
{ text: 'Frontend', link: '/Frontend' },
16+
{ text: 'Backend', link: '/Backend' },
1517
]
1618
}
1719
]

docs/Backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The services are all implemented, and served, as REST API exposed by the [connex
88

99
## CoderBot API
1010

11-
See the full specification of the [CoderBot REST API](./api_v1/README.md).
11+
See the full specification of the [CoderBot REST API](./api.md).
1212

1313
## Features
1414

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy