Skip to content

Commit 8bad416

Browse files
authored
Merge pull request #42 from seatable/harmonize-dev-user-docs
Restructure developer docs by language
2 parents 33ca899 + db8a024 commit 8bad416

86 files changed

Lines changed: 2170 additions & 5250 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,46 @@
1-
name: Deploy developer.setable.io (mkdocs material based with github pages)
1+
name: Deploy developer.seatable.com (mkdocs material with github pages)
22

33
on:
44
push:
55
branches:
66
- main
77
pull_request:
8+
branches:
9+
- main
10+
11+
env:
12+
GO_VERSION: 1.24.1
13+
MUFFET_VERSION: v2.10.7
814

915
permissions:
1016
contents: write
1117

1218
jobs:
19+
check-links:
20+
name: Check links
21+
runs-on: ubuntu-22.04
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
- uses: actions/setup-go@v2
26+
with:
27+
go-version: ${{ env.GO_VERSION }}
28+
- name: Start development server
29+
run: ./preview.sh
30+
- name: Add $GOPATH/bin to $PATH
31+
run: |
32+
echo "$(go env GOPATH)/bin" >> "$GITHUB_PATH"
33+
- name: Install muffet
34+
run: go install github.com/raviqqe/muffet/v2@${MUFFET_VERSION}
35+
- name: Check links
36+
run: muffet -t60 -c10 -f -i 'http://127*' -i 'http://localhost' http://127.0.0.1:8000
1337
deploy:
1438
runs-on: ubuntu-latest
39+
needs:
40+
- check-links
41+
if: github.ref == 'refs/heads/main'
1542
steps:
16-
- uses: actions/checkout@v3
43+
- uses: actions/checkout@v4
1744
with:
1845
fetch-depth: 0
1946

@@ -31,5 +58,4 @@ jobs:
3158
run: mkdocs build --strict --verbose
3259

3360
- name: gh-deploy
34-
if: github.ref == 'refs/heads/main'
3561
run: mkdocs gh-deploy --force

‎docs/clients/index.md‎

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

‎docs/clients/javascript/columns.md‎

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

‎docs/clients/javascript/constants.md‎

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

‎docs/clients/javascript/javascript_api.md‎

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

0 commit comments

Comments
 (0)