build: upgrade Docusaurus to 3.10 and enable Docusaurus Faster

.github/workflows/publish.yaml

@@ -18,12 +18,13 @@ jobs:
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
     - uses: actions/checkout@v7
+    - uses: pnpm/action-setup@v6
     - uses: actions/setup-node@v7
       with:
         node-version-file: .node-version
-        cache: yarn
+        cache: pnpm
     - name: Install dependencies
-      run: yarn install --frozen-lockfile
+      run: pnpm install --frozen-lockfile
     - name: Fetch API documentation
       run: |
         curl -SsL "https://raw.githubusercontent.com/${ORG}/${REPO}/${BRANCH}/${FILE_PATH}" \
@@ -36,7 +37,7 @@ jobs:
         FILE_PATH: api/statuscake/service/statuscake/openapi.yaml
         GITHUB_TOKEN: ${{ secrets.MACHINE_TOKEN }}
     - name: Build website
-      run: yarn build
+      run: pnpm build
     - name: Deploy to GitHub Pages
       uses: peaceiris/actions-gh-pages@v4
       with:

.github/workflows/test.yaml

@@ -12,11 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v7
+    - uses: pnpm/action-setup@v6
     - uses: actions/setup-node@v7
       with:
         node-version-file: .node-version
-        cache: yarn
+        cache: pnpm
     - name: Install dependencies
-      run: yarn install --frozen-lockfile
+      run: pnpm install --frozen-lockfile
     - name: Typecheck
-      run: yarn typecheck
+      run: pnpm typecheck

.gitignore

@@ -15,7 +15,6 @@
 .env.production.local
 
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+pnpm-debug.log*
 
 /src/spec

.gitlint

@@ -6,11 +6,5 @@ contrib=contrib-title-conventional-commits
 ignore=body-is-missing
 regex-style-search=True
 
-[title-max-length]
-line-length=50
-
-[body-max-line-length]
-line-length=72
-
 [ignore-body-lines]
 regex=(^Co-Authored-By)|(^Signed-off-by)|(.*)https?://(.*)

.node-version

@@ -1 +1 @@
-18.1.0
+26.10.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviours that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the [project team](mailto:support@statuscake.com). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# How To Contribute
+
+Contributions are welcome as we strive to make this documentation as useful as
+possible for everyone. However time is not always on our side, and changes may
+not be reviewed or merged in a timely manner.
+
+If the documentation is found to be missing information, please open an issue
+describing the proposed change - discussing changes ahead of time reduces
+friction within pull requests.
+
+## Prerequisites
+
+You will need the following things properly installed on your computer:
+
+- [Git](https://git-scm.com/)
+- [Node.js](https://nodejs.org/en/) 20 or later
+
+## Installation
+
+- `git clone <repository-url>` this repository
+- `cd portal`
+- `pnpm install`
+
+## Running / Development
+
+- `pnpm start`
+- Visit your app at [http://localhost:3000](http://localhost:3000).
+
+## Running tests
+
+- `pnpm test`
+
+## Deployment
+
+The website is automatically published when an update is pushed to the master
+branch. The state of any active deployment task can be seen in the [GitHub
+Actions](https://github.com/StatusCakeDev/portal/actions/workflows/deploy.yaml)
+tab.
+
+## Making Changes
+
+See the contributing guide at
+[devhandbook.org](https://devhandbook.org/contributing)
+
+## Further Reading / Useful Links
+
+- [Node.js](https://nodejs.org/en/)
+- [Docusaurus](https://docusaurus.io/)