docs: fixed docs errors and major typos #1081
Workflow file for this run
This file contains 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
| name: Guides | |
| on: | |
| pull_request: | |
| jobs: | |
| ## SPELL CHECK ALL GUIDES | |
| spell-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v3 | |
| - uses: rojopolis/[email protected] | |
| name: Spellcheck | |
| with: | |
| config_path: .spellcheck.yml | |
| task_name: SPCheck | |
| ## LINT CHECK ALL GUIDES | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| # SETUP & INSTALL | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| - uses: ./.github/actions/setup-node | |
| with: | |
| install: false | |
| - name: Install dependencies | |
| run: npm install -g [email protected] | |
| # RUN LINT CHECK | |
| - name: Lint Check | |
| run: markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' | |
| ## GUIDES E2E TESTS | |
| guides-e2e-tests: | |
| timeout-minutes: 30 | |
| name: Guides E2E Tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| # note: must match the names in test.spec.ts | |
| guide: | |
| - "intro to sway" | |
| - "counter-dapp" | |
| - "intro to predicates" | |
| - "quickstart" | |
| steps: | |
| # SETUP | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'true' | |
| - uses: ./.github/actions/setup-node | |
| with: | |
| install: false | |
| - uses: dtolnay/rust-toolchain@stable | |
| # INSTALLATIONS | |
| - name: Install dependencies | |
| run: pnpm install | |
| - name: Install Playwright Browsers | |
| run: npx playwright install --with-deps chromium | |
| - name: Install cargo-generate | |
| run: cargo install cargo-generate --locked | |
| - name: Install Fuelup | |
| run: | | |
| curl https://install.fuel.network | sh | |
| - name: Modify Path | |
| run: echo "$HOME/.fuelup/bin:${GITHUB_PATH}" >> $GITHUB_PATH | |
| # RUN E2E TESTS | |
| - name: Run Playwright tests for ${{ matrix.guide }} | |
| run: xvfb-run --auto-servernum pnpm test:guides --grep "${{ matrix.guide }}" | |
| - uses: actions/upload-artifact@v4 | |
| if: always() | |
| with: | |
| name: playwright-report-${{ matrix.guide }} | |
| path: playwright-report/ | |
| retention-days: 30 |