feat(docs): build docs in CI and deploy to gh pages (#849)

docs(gha): setup gha to build docs and ensure site builds

Author: lwasser

.github/workflows/build-website.yml

@@ -0,0 +1,44 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Build website
+        run: |
+          npm run build
+          ls website/build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/build/all-contributors
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -11,8 +11,9 @@ desktop.ini
 # Optional eslint cache
 .eslintcache
 
-# npm
-package-lock.json
+# yarn
+#package-lock.json
+yarn.lock
 
 # Optional npm cache directory
 .npm

CONTRIBUTING.md

@@ -1,3 +1,14 @@
+# Contribute to the All Contributors bot
+
+We welcome contributions of all kinds to AllContributors.
+
+## 13 August 2025 Update:
+
+Currently, we are doing some work to revive the project. The documentation 
+website is not online but we are working to get it online soon. 
+
+************* THE LINKS BELOW DON'T CURRENTLY WORK ******
+
 Read the contributing docs in:
 
 - <a href="https://allcontributors.org/docs/en/project/contribute">English</a>

docs/project/contribute.md

@@ -62,13 +62,17 @@ After you translate strings in any given language, you won't see those changes a
 
 Search is by algolia, the configuration is at <https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json>
 
-## Running the site locally:
+## Run the website locally:
 
 All Contributors currently uses [Docusaurus 1.x](https://docusaurus.io) for our documentation website.
 
 To build the docs locally:
 
-Make sure `npm` is installed on your machine. Use the [nodejs documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you aren't sure how to install `npm`.
+
+* https://tutorial.docusaurus.io/docs/intro
+
+1. Make sure `npm` is installed on your machine. Use the [nodejs documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you aren't sure how to install `npm`.
+
 To check that npm is installed run the following in your favorite shell:
 
 `npm -v`
@@ -78,11 +82,11 @@ use:
 
 `node -v`
 
-If you don't have at least version `0.22` or higher, please install Node or upgrade your current version.
-
+If you don't have atleast version `.22` or higher, please install node or upgrade your current version.
 Install docusaurus v1 (1.14.7) and all of the project dependencies using `npm install`. *Note: This project does not yet support docusaurus v2 or v3; though, we hope to do so in the future.*
+**`npm i` is shorthand for `npm install`)**:
 
-`npm install`
+`npm i`
 
 Once you have completed the above, you can launch a server locally that will build and run the docs locally. In your favorite shell run:
 
@@ -98,7 +102,7 @@ check those changes. To run the linter yourself on a file locally:
 
 First install markdownlint-cli:
 
-`npm install -g markdownlint-cli`
+`npm i -g markdownlint-cli`
 
 Then run markdownlint on the file (or files) that you wish to check: