chore: switch from npm to pnpm and update build scripts
This commit is contained in:
28
README.md
28
README.md
@@ -33,20 +33,20 @@ The site is designed to match the feel of the main `www.projectmycelium.com` sit
|
|||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Node.js **18+** (LTS recommended).
|
- Node.js **18+** (LTS recommended).
|
||||||
- npm (comes with Node).
|
- [pnpm](https://pnpm.io/) (recommended) or npm (comes with Node).
|
||||||
|
|
||||||
### Install Dependencies
|
### Install Dependencies
|
||||||
|
|
||||||
From the project root (`docs_projectmycelium`):
|
From the project root (`docs_projectmycelium`):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
pnpm install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run the Dev Server
|
### Run the Dev Server
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
pnpm start
|
||||||
```
|
```
|
||||||
|
|
||||||
Then open:
|
Then open:
|
||||||
@@ -65,7 +65,7 @@ The main sections are available at:
|
|||||||
### Build the Site
|
### Build the Site
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
This creates a production build in the `build/` directory.
|
This creates a production build in the `build/` directory.
|
||||||
@@ -73,22 +73,22 @@ This creates a production build in the `build/` directory.
|
|||||||
### Serve the Production Build (Local Test)
|
### Serve the Production Build (Local Test)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run serve
|
pnpm serve
|
||||||
```
|
```
|
||||||
|
|
||||||
Docusaurus will serve the contents of `build/` so you can verify the production build locally.
|
Docusaurus will serve the contents of `build/` so you can verify the production build locally.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## npm Scripts
|
## Package Scripts
|
||||||
|
|
||||||
Defined in `package.json`:
|
Defined in `package.json` (run with `pnpm <script>` or `pnpm run <script>`):
|
||||||
|
|
||||||
- `npm start` – Start local dev server (hot reload).
|
- `start` – Start local dev server (hot reload).
|
||||||
- `npm run build` – Build static site into `build/`.
|
- `build` – Build static site into `build/`.
|
||||||
- `npm run serve` – Serve the built site locally.
|
- `serve` – Serve the built site locally.
|
||||||
- `npm run deploy` – Run Docusaurus deploy (GitHub Pages style; see below).
|
- `deploy` – Run Docusaurus deploy (GitHub Pages style; see below).
|
||||||
- `npm run clear` – Clear Docusaurus caches.
|
- `clear` – Clear Docusaurus caches.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -133,7 +133,7 @@ The Docusaurus config assumes:
|
|||||||
1. **Build the site** on your local machine or CI:
|
1. **Build the site** on your local machine or CI:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
This produces static assets under `build/`.
|
This produces static assets under `build/`.
|
||||||
@@ -171,7 +171,7 @@ The Docusaurus config assumes:
|
|||||||
1. Create a branch from the main docs branch.
|
1. Create a branch from the main docs branch.
|
||||||
2. Add or update Markdown files under `docs/`.
|
2. Add or update Markdown files under `docs/`.
|
||||||
3. Keep slugs and sidebar entries consistent with the existing IA.
|
3. Keep slugs and sidebar entries consistent with the existing IA.
|
||||||
4. Run `npm run build` locally before opening a PR to catch broken links.
|
4. Run `pnpm build` locally before opening a PR to catch broken links.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -115,4 +115,4 @@ As the framework evolves, expect more detailed specifications around:
|
|||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
The architecture described here is intentionally high‑level and forward‑looking. For timelines and how to prepare, see **[Overview](/ai-agent-framework/overview)** and **[Getting Ready for Agents](/ai-agent-framework/getting-ready)**.
|
The architecture described here is intentionally high‑level and forward‑looking. For timelines and how to prepare, see **[Overview](/ai-agent-framework)** and **[Getting Ready for Agents](/ai-agent-framework/getting-ready)**.
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ If you plan to run larger AI workloads, consider capacity with GPUs or high‑me
|
|||||||
|
|
||||||
If you want agents to run on hardware beyond your personal machines, look into becoming a **hoster**:
|
If you want agents to run on hardware beyond your personal machines, look into becoming a **hoster**:
|
||||||
|
|
||||||
- Read **[Hosters Overview](/hosters/overview)** to understand the role.
|
- Read **[Hosters Overview](/hosters)** to understand the role.
|
||||||
- Choose hardware via **[Buy or Build a Node](/hosters/buy-node)** and **[Advanced Node Options](/hosters/advanced-nodes)**.
|
- Choose hardware via **[Buy or Build a Node](/hosters/buy-node)** and **[Advanced Node Options](/hosters/advanced-nodes)**.
|
||||||
- Set up your node using **[Set Up Your Node](/hosters/setup)**.
|
- Set up your node using **[Set Up Your Node](/hosters/setup)**.
|
||||||
- Learn about **[Hosting Economics (SPORE)](/hosters/economics)**.
|
- Learn about **[Hosting Economics (SPORE)](/hosters/economics)**.
|
||||||
|
|||||||
@@ -16,6 +16,7 @@
|
|||||||
"@docusaurus/theme-mermaid": "^3.5.2",
|
"@docusaurus/theme-mermaid": "^3.5.2",
|
||||||
"@mdx-js/react": "^3.0.0",
|
"@mdx-js/react": "^3.0.0",
|
||||||
"clsx": "^2.0.0",
|
"clsx": "^2.0.0",
|
||||||
|
"docs_projectmycelium": "link:",
|
||||||
"prism-react-renderer": "^2.3.0",
|
"prism-react-renderer": "^2.3.0",
|
||||||
"react": "^18.2.0",
|
"react": "^18.2.0",
|
||||||
"react-dom": "^18.2.0"
|
"react-dom": "^18.2.0"
|
||||||
|
|||||||
Reference in New Issue
Block a user