Skip to content

Commit a334dd7

Browse files
committed
2 parents 1377074 + 3d33714 commit a334dd7

31 files changed

+447
-16499
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,6 @@ jobs:
4242
npm run test:integration
4343
- name: Lint
4444
run: npm run lint:check
45-
- name: Check for changes to docs
46-
run: npm run mkdocs
47-
- name: Auto commit docs changes if any
48-
uses: stefanzweifel/git-auto-commit-action@v4
49-
with:
50-
commit_message: Apply docs changes
51-
file_pattern: docs/api/*.md
5245
- name: Genrate test coverage report
5346
run: npm run coveralls-after
5447
- name: Update coveralls

.github/workflows/docs.yml

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
1-
name: Create PR on Docs repo
1+
name: Upload code docs to TerminusCMS
22
on:
33
push:
4-
paths:
5-
- 'docs/api/**'
6-
branches:
7-
- main
4+
tags:
5+
- v*
6+
workflow_dispatch:
87

98
jobs:
109
pull-request:
1110
runs-on: ubuntu-latest
1211
steps:
1312
- name: Checkout
14-
uses: actions/checkout@v2
15-
- name: Set BRANCH_NAME
16-
run: echo "BRANCH_NAME=JS-Reference-Updates-$(date +%s)" >> $GITHUB_ENV
17-
- name: Create pull request in terminusdb/terminusdb-docs
18-
uses: paygoc6/action-pull-request-another-repo@v1.0.1
19-
env:
20-
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
21-
with:
22-
source_folder: 'docs/api/.'
23-
destination_repo: 'terminusdb/terminusdb-docs'
24-
destination_folder: 'guides/reference-guides/javascript-client-reference'
25-
destination_base_branch: 'main'
26-
destination_head_branch: ${{ env.BRANCH_NAME }}
27-
user_email: 'neel@terminusdb.com'
28-
user_name: 'Neelterminusdb'
29-
pull_request_reviewers: 'mark-terminusdb'
13+
uses: actions/checkout@v3
14+
- name: Clone JSDoc template
15+
run: git clone https://github.com/terminusdb-labs/jsdoc-terminusdb-template.git
16+
- name: Run NPM Install
17+
run: npm i
18+
- name: Run JSDoc
19+
run: npx jsdoc --template ./jsdoc-terminusdb-template --recurse ./lib/ > docs.json || true
20+
- name: Upload to TerminusCMS
21+
run: |
22+
curl -H 'Authorization: Token ${{ secrets.TERMINUSCMS_TOKEN}}' \
23+
-H 'Content-Type: application/json' \
24+
'${{ secrets.TERMINUSCMS_URL}}' -d @./docs.json

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ package, run:
4848
$ npm install --save @terminusdb/terminusdb-client
4949
```
5050

51-
This command update your `package.json`.
51+
This command updates your `package.json`.
5252

5353
### Script
5454

@@ -69,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
6969
This example creates a simple dataProduct, starting to create a database model the schema
7070
and insert a simple document
7171

72-
For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
72+
For the [full Documentation](https://terminusdb.com/docs/javascript)
7373

7474
```javascript
7575
const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -158,9 +158,9 @@ The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-doc
158158

159159
## Report Issues
160160

161-
If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
161+
If you encounter any issues, please report it with your os and environment setup, the version that you are using, and a simple reproducible case.
162162

163-
If you encounter other questions, you can ask in our [Discord Server](https://discord.gg/hTU3XWSzuZ).
163+
If you encounter other questions, you can ask them on our [Discord Server](https://discord.gg/hTU3XWSzuZ).
164164

165165
## Contribute
166166

docs/README.md

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

0 commit comments

Comments
 (0)