chore: update docs

* chore(README): add git submodule init step & contributing instructions

* chore(apps/api): add README

* chore(apps/hub): add README

* chore(apps/status.app): update README & add comment regarding vaults disabling

* chore: add changeset

* chore(README): remove useless git commands

* chore(README): fix broken note

* chore(README): fix broken code in note

.changeset/floppy-hands-lead.md

@@ -0,0 +1,7 @@
+---
+'status.app': patch
+'api': patch
+'hub': patch
+---
+
+chore: update docs

README.md

@@ -57,6 +57,7 @@ Optional:
 
           git clone https://github.com/status-im/status-web.git
           cd status-web
+          git submodule update --init --recursive
 
 > [!NOTE]
 > If using Nix, enter development shell:
@@ -81,6 +82,39 @@ Optional:
 
         pnpm dev
 
+## Contributing
+
+To contribute changes via a pull request:
+
+1.  Fork the repository on GitHub: open [status-im/status-web](https://github.com/status-im/status-web), click "Fork", and create your fork under your account.
+
+2.  Clone your fork and add the official repo as `upstream`:
+
+        git clone https://github.com/YOUR_USERNAME/status-web.git
+        cd status-web
+        git remote add upstream https://github.com/status-im/status-web.git
+        git submodule update --init --recursive
+
+3.  Create a branch, make your changes, then push to your fork:
+
+        git checkout -b your-branch-name
+        # make changes, then:
+        git add .
+        git commit -m "your commit message"
+        git push origin your-branch-name
+
+4.  Open a pull request on GitHub: go to your fork, click "Compare & pull request" for your branch, and open the PR against `status-im/status-web` (base: `main`).
+
+> [!NOTE]
+> Keep your fork in sync before starting new work:
+>
+> ```bash
+> git fetch upstream
+> git checkout main
+> git merge upstream/main
+> git push origin main
+> ```
+
 ## Storybook
 
 To view and interact with the components, you can run Storybook:

apps/api/README.md

@@ -0,0 +1,39 @@
+# Status API
+
+This is the repository for the Status API.
+
+## Prerequisites
+
+Required:
+
+- **[Node.js](https://nodejs.org/)** v22.x
+- **[pnpm](https://pnpm.io)** v9.12.x
+
+## Getting Started
+Go to the project directory:
+
+```bash
+  cd apps/api
+```
+
+Install dependencies:
+
+```bash
+  pnpm install
+```
+
+Pull environment variables:
+
+```bash
+  vercel env pull .env.local
+```
+> [!NOTE]
+> This project is deployed on Vercel at [https://vercel.com/status-im-web/status-api](https://vercel.com/status-im-web/status-api).
+> You can also get the environment variables manually from [there](https://vercel.com/status-im-web/status-api/settings/environment-variables). However this is recommended to pull envs through the Vercel CLI as there are a lot of them.
+
+
+Start the development server:
+
+```bash
+  pnpm dev
+```

apps/hub/README.md

@@ -0,0 +1,48 @@
+# Status Network Hub
+
+This is the repository for [https://hub.status.network/](https://hub.status.network/) – Gasless Ethereum Layer 2 with Privacy.
+
+## Prerequisites
+
+Required:
+
+- **[Node.js](https://nodejs.org/)** v22.x
+- **[pnpm](https://pnpm.io)** v9.12.x
+
+## Getting Started
+Go to the project directory:
+
+```bash
+  cd apps/hub
+```
+
+Install dependencies:
+
+```bash
+  pnpm install
+```
+
+Pull environment variables:
+
+```bash
+  vercel env pull .env.local
+```
+> [!NOTE]
+> This project is deployed on Vercel at [https://vercel.com/status-im-web/status-network-hub](https://vercel.com/status-im-web/status-network-hub).
+> You can also get the environment variables manually from [there](https://vercel.com/status-im-web/status-network-hub/settings/environment-variables).
+
+> [!NOTE]
+> `NEXT_PUBLIC_STATUS_NETWORK_API_URL`: Base URL for the Status Network API used by the hub for auth, current user (`/auth/me`), karma/sybil (proof-of-work), predeposit vaults APY, and captcha. You can run this API locally by cloning the sn-api repo [https://github.com/status-im/sn-api](https://github.com/status-im/sn-api). If you do so don't forget to change the value of this variable to the local API's URL.
+>
+> `NEXT_PUBLIC_STATUS_API_URL`: Base URL for the Status API used by the hub to fetch token exchange rates (market data).
+> You can run this API locally by running `pnpm dev` in the [api](https://github.com/status-im/status-web/tree/main/apps/api) project. If you do so don't forget to change the value of this variable to `http://localhost:3030`.
+
+Start the development server:
+
+```bash
+  pnpm dev
+```
+
+Open [http://localhost:3003](http://localhost:3003) with your browser to see the result.
+
+You can start editing the pages. Pages auto-update as you edit the file.

apps/hub/src/app/_components/vault-card.tsx

@@ -146,6 +146,7 @@ const VaultCardContent: FC<VaultCardContentProps> = ({
 
   const vaultAddressLower = vault.address.toLowerCase()
   const isVaultInApi = apyMap !== undefined && vaultAddressLower in apyMap
+  // If the query inside useVaultsAPY fails, all vaults are disabled even though they might technically work
   const isDisabled = !isVaultInApi
   const dynamicApy = apyMap?.[vaultAddressLower]
   const apyValue = dynamicApy !== undefined ? String(dynamicApy) : null

apps/status.app/README.md

@@ -4,7 +4,7 @@ This is the repository for the [https://status.app](https://status.app) – a [N
 
 ## Prerequisites
 
-- [Node.js](https://nodejs.org/en/) `v18.x.x`
+- **[Node.js](https://nodejs.org/)** v22.x
 - **[pnpm](https://pnpm.io)** v9.12.x
 
 ## Getting Started
@@ -13,8 +13,7 @@ Clone the project:
 
 ```bash
   git clone https://github.com/status-im/status-website.git
-  git submodule init
-  git submodule update
+  git submodule update --init --recursive
 ```
 
 Optionally, update submodules: