Skip to content

Commit 3b2211b

Browse files
authored
Merge pull request Open-Science-Community-Saudi-Arabia#150 from RealRichi3/feat/jsdoc
[02/01/2023] feat - Improved documentation for backend_API
2 parents 62764b7 + 453cf50 commit 3b2211b

17 files changed

+18890
-3960
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ vignettes/*.pdf
8585
# Backend API sensitive files
8686
/backend_API/src/*.env
8787
*node_modules/
88+
./backend_API/out
8889

8990
# Frontend
9091
# Logs

CONTRIBUTING.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

backend_API/_book/api.md

Whitespace-only changes.

backend_API/_book/intro.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# astx-redux-util
2+
3+
The is our **introduction** to astx-redux-util.
4+
5+
Here are some references to the [Getting Started](start.md) and [API](api.md).

backend_API/_book/start.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Getting Started
2+
3+
This is the **Getting Started** section.
4+
5+
Here are some references to the [Introduction](intro.md) and [API](api.md).

backend_API/_book/toc.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Table of content
2+
* [Getting Started](start.md)
3+
* [API Reference](api.md)

backend_API/book.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"gitbook": "3.2.2",
3+
"root": "./docs",
4+
"structure": {
5+
"readme": "intro.md",
6+
"summary": "toc.md"
7+
}
8+
}

backend_API/jsdoc.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"source": {
3+
"include": ["./src/controllers"],
4+
"includePattern": ".js$",
5+
"excludePattern": "(node_modules/|docs)"
6+
},
7+
"plugins": ["plugins/markdown"],
8+
"templates": {
9+
"cleverLinks": true,
10+
"monospaceLinks": true
11+
},
12+
"opts": {
13+
"destination": "./docs/",
14+
"recurse": true,
15+
"verbose": true
16+
}
17+
}

0 commit comments

Comments
 (0)