Skip to content

Commit

Permalink
docs(turbopack): conslidate existing links (vercel#62034)
Browse files Browse the repository at this point in the history
### What?

This PR improves turbopack documentation, mostly collects existing
documents into a single place.

Also, adds a support to render mermaid diagram.

Closes PACK-2488
  • Loading branch information
kwonoj authored Feb 14, 2024
1 parent 7ba4a0d commit 65dc55a
Show file tree
Hide file tree
Showing 18 changed files with 195,629 additions and 7 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ bench/nested-deps-app-router/**
packages/next-bundle-analyzer/index.d.ts
examples/with-typescript-graphql/lib/gql/
test/development/basic/hmr/components/parse-error.js
packages/next-swc/docs/assets/**/*
7 changes: 7 additions & 0 deletions .github/workflows/build_and_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,14 @@ jobs:
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: 'latest'
- name: Install cargo-binstall
uses: cargo-bins/[email protected]

- uses: Swatinem/rust-cache@v2

- run: |
cargo binstall mdbook-mermaid --no-confirm
- name: Deploy preview docs
if: ${{ needs.build.outputs.isRelease != 'true' }}
run: ./scripts/deploy-turbopack-docs.sh
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ jobs:
needsRust: 'yes'
skipInstallBuild: 'yes'
skipNativeBuild: 'yes'
afterBuild: ./scripts/deploy-turbopack-docs.sh
afterBuild: cargo binstall mdbook-mermaid --no-confirm && ./scripts/deploy-turbopack-docs.sh
stepName: 'rust-doc-check'
secrets: inherit

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/build_reusable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ jobs:
with:
mdbook-version: 'latest'

- name: Install cargo-binstall
uses: cargo-bins/[email protected]

- name: 'Install mold linker'
if: ${{ inputs.mold == 'yes' }}
run: |
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ packages/next/src/bundles/webpack/packages/lazy-compilation-*.js
packages/next-swc/crates/**/tests/**/output*
packages/next-swc/crates/core/tests/loader/issue-32553/input.js
packages/next-swc/native/**/*
packages/next-swc/docs/assets/**/*

packages/next-codemod/transforms/__testfixtures__/**
packages/next-codemod/transforms/__tests__/**
Expand Down
1 change: 1 addition & 0 deletions packages/next-swc/docs/assets/mermaid-init.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mermaid.initialize({ startOnLoad: true })
Loading

0 comments on commit 65dc55a

Please sign in to comment.