-
Notifications
You must be signed in to change notification settings - Fork 53
docs: rework documentation #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
7cdb42d
Rework documentation
andreiltd a5022d4
Merge branch 'main' into docs
andreiltd bd58d0e
Address code review feedback
andreiltd 0bfba18
Add note about installing builtins
andreiltd a1b8c5a
Apply suggestions from code review
andreiltd e84a233
Try using cargo binstall for mdbook
andreiltd 73745f6
Improve indentation
andreiltd 7dd10a0
Fix note rendering
andreiltd 90d2f2d
Use alerts for GC note
andreiltd f9fc07e
Remove duplicated section
andreiltd 43f53c6
Quote test filters
andreiltd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| name: Deploy mdbook documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| changes: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| outputs: | ||
| docs-changed: ${{ steps.filter.outputs.docs == 'true' }} | ||
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
| - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 #v3.0.2 | ||
| id: filter | ||
| with: | ||
| filters: | | ||
| docs: docs/** | ||
|
|
||
| deploy: | ||
| needs: [changes] | ||
|
andreiltd marked this conversation as resolved.
|
||
| if: ${{ !contains(needs.changes.outputs.docs-changed, '[]') }} | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 3 | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Install cargo-binstall | ||
| uses: cargo-bins/cargo-binstall@8aac5aa2bf0dfaa2863eccad9f43c68fe40e5ec8 # v1.14.1 | ||
|
|
||
| - name: Install mdbook tools | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| run: | | ||
| cargo binstall --no-confirm mdbook@0.4.48 | ||
| cargo binstall --no-confirm mdbook-alerts@0.7.0 | ||
| cargo binstall --no-confirm mdbook-linkcheck@0.7.7 | ||
|
|
||
| - name: Build mdbook | ||
| working-directory: ./docs | ||
| run: mdbook build | ||
|
|
||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v4 | ||
| if: ${{ github.ref == 'refs/heads/main' }} | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./docs/book/html | ||
| keep_files: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| # StarlingMonkey Adopters | ||
|
|
||
| _If you are using StarlingMonkey in production at your organization, please add your company name to this list. | ||
| The list is in alphabetical order._ | ||
| _If you are using StarlingMonkey in production at your organization, please add your company name to | ||
| this list. The list is in alphabetical order._ | ||
|
|
||
| | Organization | Contact | Status | Description of Use | | ||
| | - | - | - | - | | ||
| | [Fastly](https://www.fastly.com) | [@guybedford](https://github.com/guybedford) |  | Fastly's [JS SDK](https://github.com/fastly/js-compute-runtime) for Compute at edge is powered by StarlingMonkey. | | ||
| | Organization | Contact | Status | Description of Use | | ||
| | ----------------------------------- | -------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [Fastly](https://www.fastly.com) | [@guybedford](https://github.com/guybedford) |  | Fastly's [JS SDK](https://github.com/fastly/js-compute-runtime) for Compute at edge is powered by StarlingMonkey. | | ||
| | [Fermyon](https://www.fermyon.com/) | [@tschneidereit](https://github.com/tschneidereit) |  | [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). | | ||
| | [Riza](https://riza.io/) | [@kyleconroy](https://github.com/kyleconroy) |  | The [Riza Code Interpreter API](https://docs.riza.io) relies on StarlingMonkey for isolated JavaScript execution. | | ||
| | [Riza](https://riza.io/) | [@kyleconroy](https://github.com/kyleconroy) |  | The [Riza Code Interpreter API](https://docs.riza.io) relies on StarlingMonkey for isolated JavaScript execution. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| 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/). | ||
| 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/). | ||
|
|
||
| Changes following that initial commit are Copyright © the respective contributors. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.