Skip to content

Commit e7bf7b7

Browse files
andreiltdandreiltd
committed
Rework documentation
1 parent 8fc0642 commit e7bf7b7

19 files changed

Lines changed: 812 additions & 278 deletions

‎.github/workflows/docs.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Deploy mdbook documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
workflow_dispatch:
9+
10+
jobs:
11+
changes:
12+
runs-on: ubuntu-22.04
13+
timeout-minutes: 10
14+
outputs:
15+
dirs: ${{ steps.filter.outputs.changes }}
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: dorny/paths-filter@v3
19+
id: filter
20+
with:
21+
filters: |
22+
docs: docs/**
23+
24+
deploy:
25+
needs: [changes]
26+
if: ${{ !contains(needs.changes.outputs.dirs, '[]') }}
27+
runs-on: ubuntu-22.04
28+
timeout-minutes: 10
29+
concurrency:
30+
group: ${{ github.workflow }}-${{ github.ref }}
31+
32+
steps:
33+
- uses: actions/checkout@v4
34+
35+
- name: Install latest mdbook
36+
run: |
37+
tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
38+
url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
39+
mkdir mdbook
40+
curl -sSL $url | tar -xz --directory=./mdbook
41+
echo `pwd`/mdbook >> $GITHUB_PATH
42+
43+
- name: Build mdbook
44+
working-directory: ./docs
45+
run: mdbook build
46+
47+
- name: Deploy
48+
uses: peaceiris/actions-gh-pages@v4
49+
if: ${{ github.ref == 'refs/heads/main' }}
50+
with:
51+
github_token: ${{ secrets.GITHUB_TOKEN }}
52+
publish_dir: ./docs/book
53+
keep_files: true
54+
55+
link_check:
56+
name: verify-doc-links
57+
needs: [deploy]
58+
if: ${{ github.ref == 'refs/heads/main' }}
59+
permissions:
60+
contents: read
61+
issues: write
62+
timeout-minutes: 15
63+
runs-on: ubuntu-latest
64+
steps:
65+
- uses: actions/checkout@v4
66+
67+
- name: Link Checker
68+
id: lychee
69+
uses: lycheeverse/lychee-action@v2
70+
with:
71+
args: ./docs --exclude-all-private --verbose
72+
fail: false

‎.github/workflows/main.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ on:
55
branches: [main]
66
pull_request:
77
branches: [main]
8+
paths-ignore:
9+
- '*.md'
10+
- 'docs/**'
811
defaults:
912
run:
1013
shell: bash

‎ADOPTERS.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# StarlingMonkey Adopters
22

3-
_If you are using StarlingMonkey in production at your organization, please add your company name to this list.
4-
The list is in alphabetical order._
3+
_If you are using StarlingMonkey in production at your organization, please add your company name to
4+
this list. The list is in alphabetical order._
55

6-
| Organization | Contact | Status | Description of Use |
7-
| - | - | - | - |
8-
| [Fastly](https://www.fastly.com) | [@guybedford](https://github.com/guybedford) | ![production](https://img.shields.io/badge/-production-blue?style=flat) | Fastly's [JS SDK](https://github.com/fastly/js-compute-runtime) for Compute at edge is powered by StarlingMonkey. |
6+
| Organization | Contact | Status | Description of Use |
7+
| ----------------------------------- | -------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8+
| [Fastly](https://www.fastly.com) | [@guybedford](https://github.com/guybedford) | ![production](https://img.shields.io/badge/-production-blue?style=flat) | Fastly's [JS SDK](https://github.com/fastly/js-compute-runtime) for Compute at edge is powered by StarlingMonkey. |
99
| [Fermyon](https://www.fermyon.com/) | [@tschneidereit](https://github.com/tschneidereit) | ![production](https://img.shields.io/badge/-production-blue?style=flat) | [Fermyon Spin](https://www.fermyon.com/spin) supports serverless Wasm apps, using StarlingMonkey for its [Spin JS SDK](https://github.com/fermyon/spin-js-sdk). |
10-
| [Riza](https://riza.io/) | [@kyleconroy](https://github.com/kyleconroy) | ![production](https://img.shields.io/badge/-production-blue?style=flat) | The [Riza Code Interpreter API](https://docs.riza.io) relies on StarlingMonkey for isolated JavaScript execution. |
10+
| [Riza](https://riza.io/) | [@kyleconroy](https://github.com/kyleconroy) | ![production](https://img.shields.io/badge/-production-blue?style=flat) | The [Riza Code Interpreter API](https://docs.riza.io) relies on StarlingMonkey for isolated JavaScript execution. |

‎AUTHORS.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
The portions of this code found in the initial commit are Copyright © 2021-2023 Fastly Inc. and contributors to Fastly's [js-compute-runtime project](https://github.com/fastly/js-compute-runtime/).
1+
The portions of this code found in the initial commit are Copyright © 2021-2023 Fastly Inc. and
2+
contributors to Fastly's
3+
[js-compute-runtime project](https://github.com/fastly/js-compute-runtime/).
24

35
Changes following that initial commit are Copyright © the respective contributors.

0 commit comments

Comments
 (0)