Skip to content

Migration of the documentation to a major version - #754

Merged
Juminstock merged 8 commits into
mainfrom
feat-juminstock/migrate-docs
Jul 15, 2025
Merged

Migration of the documentation to a major version#754
Juminstock merged 8 commits into
mainfrom
feat-juminstock/migrate-docs

Conversation

@Juminstock

Copy link
Copy Markdown
Contributor

This PR implements the following detailed changes:

  1. Update Yarn to version 4.9.2.
  2. Update Node.js to version 22.17.0 or a similar or higher version.
  3. Update Docusaurus to version 3.8.1.
  4. Update all Docusaurus dependencies and sub dependencies.
  5. Migrate docusaurus.config.js to its TypeScript version
  6. Migrate sidebars.js to its TypeScript version
  7. Fix all the errors mentioned in this issue → Upgrade & fix Astar Documentation Tasks #752.

Finally, resolve occurrences of broken links, duplicated links, or links with no clear destination; improve the descriptions of the different documentation sections; and enhance the footer and parts of the Home page.

@Juminstock
Juminstock requested review from a team as code owners July 12, 2025 05:53
@Juminstock Juminstock added documentation Improvements or additions to documentation enhancement New feature or request dependencies Pull requests that update a dependency file labels Jul 12, 2025
@Juminstock Juminstock linked an issue Jul 12, 2025 that may be closed by this pull request
Comment on lines +17 to +23
- name: Enable Corepack
run: corepack enable
shell: bash

- name: Prepare Yarn
run: corepack prepare yarn@4.9.2 --activate
shell: bash

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like these lines need to be running before setup-node. If they fail to run due to node not being installed, maybe do setup-node twice with the first one not doing the cache. Still, I feel like there's a better way to do this overall

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JGJP Thank you for your comment. In that case, based on the context you provided, I believe running setup-node twice will be the most effective and clean solution for now. The implementation would look like this:

name: Setup Workspace
description: Setup Node.js, Yarn v4 with Corepack, and install dependencies
inputs:
  build:
    description: 'Whether to run `yarn build` after install'
    required: false
    default: 'false'

runs:
  using: composite
  steps:
    # Step 1: Setup Node.js without Yarn cache (just to activate Corepack/Yarn)
    - name: Setup Node.js (no cache)
      uses: actions/setup-node@v3
      with:
        node-version: 22.x
        cache: false

    - name: Enable Corepack
      run: corepack enable
      shell: bash

    - name: Prepare Yarn 4.9.2
      run: corepack prepare yarn@4.9.2 --activate
      shell: bash

    # Step 2: Setup Node.js again — now with Yarn cache enabled
    - name: Setup Node.js (with Yarn cache)
      uses: actions/setup-node@v3
      with:
        node-version: 22.x
        cache: yarn

    - name: Install dependencies with Yarn
      run: yarn install --immutable
      shell: bash

    - name: Build project (optional)
      if: inputs.build == 'true'
      run: yarn build
      shell: bash

@JGJP what do you think?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, let's try it and see if the build runs

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it's building, there's some error about Buffer but seems unrelated

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it worked!

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might be able to get away with removing the yarn preparation step

@github-actions

github-actions Bot commented Jul 15, 2025

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit f6222b5):

https://astar-docs--pr754-feat-juminstock-migr-exvgwpit.web.app

(expires Tue, 22 Jul 2025 03:20:48 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: f2f13e9b593d211faae6343d67a88fac3fd7268d

@Juminstock

Copy link
Copy Markdown
Contributor Author

@JGJP I think the implementation it's ready. The buffer error is related to image-size library, but works on the documentation already.

Could you review the PR now, please?

@Juminstock
Juminstock requested a review from JGJP July 15, 2025 03:52
@JGJP

JGJP commented Jul 15, 2025

Copy link
Copy Markdown

@Juminstock could you add me to the repo? I'm not able to approve

@andabak andabak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved but noticing the same issue in logs as already mentioned in discussion.

I run locally and it renders docs so I guess it's acceptable to merge and then work on solving the issue with less moving parts.

TypeError: The "buffer" argument must be an instance of Buffer, TypedArray, or DataView. Received an instance of ArrayBuffer

@Juminstock
Juminstock merged commit ec3eb68 into main Jul 15, 2025
3 checks passed
@Juminstock
Juminstock deleted the feat-juminstock/migrate-docs branch July 15, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Upgrade & fix Astar Documentation Tasks

6 participants