Update README.md to enhance setup instructions and add blog post guidelines

Author: mingcheng

README.md

@@ -1,41 +1,122 @@
-# Website
+# inclusionAI Website
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+Official website for [inclusionAI](https://github.com/inclusionAI), built with [Docusaurus 3](https://docusaurus.io/).
 
-## Installation
+## Prerequisites
+
+- Node.js ≥ 20
+- [pnpm](https://pnpm.io/) (used as the package manager)
+
+## Quick Start
 
 ```bash
-yarn
+pnpm install
+pnpm start
 ```
 
-## Local Development
+`pnpm start` launches a local dev server at `http://localhost:3000` with hot-reload.
+
+## Available Commands
+
+| Command                     | Description                             |
+| --------------------------- | --------------------------------------- |
+| `pnpm start`                | Start local dev server (English locale) |
+| `pnpm start -- --locale zh` | Start dev server in Chinese locale      |
+| `pnpm build`                | Production build (output in `build/`)   |
+| `pnpm serve`                | Serve the production build locally      |
+| `pnpm clear`                | Clear Docusaurus cache                  |
+| `pnpm typecheck`            | Run TypeScript type-checking            |
+| `pnpm write-translations`   | Extract i18n translation strings        |
+
+## Adding a Blog Post
+
+### 1. Create the post directory and file
 
-```bash
-yarn start
+```
+blog/<post-slug>/index.mdx
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+### 2. Add required frontmatter
 
-## Build
+```yaml
+---
+title: "Your Post Title"
+date: 2025-01-01
+authors: [inclusionai]
+tags: [model, release]
+---
+```
 
-```bash
-yarn build
+**Frontmatter fields:**
+
+| Field             | Required | Description                                       |
+| ----------------- | -------- | ------------------------------------------------- |
+| `title`           | Yes      | Post title (shown in listings and page `<title>`) |
+| `date`            | Yes      | Publication date (`YYYY-MM-DD`)                   |
+| `authors`         | Yes      | Author key(s) from `blog/authors.yml`             |
+| `tags`            | No       | Tag list for filtering                            |
+| `draft`           | No       | Set `true` to hide from build output              |
+| `custom_edit_url` | No       | Set `null` to hide the "Edit this page" link      |
+
+### 3. Add a Chinese translation (optional)
+
+Create the same file at:
+
+```
+i18n/zh/docusaurus-plugin-content-blog/<post-slug>/index.mdx
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+The Chinese version needs the same frontmatter; only the body content needs to be translated.
 
-## Deployment
+### 4. Including assets
 
-Using SSH:
+Place images and other assets in the same directory as `index.mdx`:
 
-```bash
-USE_SSH=true yarn deploy
 ```
+blog/<post-slug>/
+├── index.mdx
+└── assets/
+    └── figure1.png
+```
+
+Reference them with a relative path: `![Figure 1](./assets/figure1.png)`.
+
+## Adding an Author
+
+Edit `blog/authors.yml`:
+
+```yaml
+your-handle:
+  name: Your Name
+  title: Your Title
+  url: https://github.com/your-handle
+  image_url: https://github.com/your-handle.png
+  email: you@example.com
+```
+
+## Math Support
+
+KaTeX is enabled. Use standard LaTeX syntax:
+
+- Inline: `$E = mc^2$`
+- Block: `$$\sum_{i=1}^{n} x_i$$`
 
-Not using SSH:
+## i18n
+
+The site ships with English (`en`, default) and Simplified Chinese (`zh`) locales.
+
+To extract new translation strings after adding content:
 
 ```bash
-GIT_USER=<Your GitHub username> yarn deploy
+pnpm write-translations --locale zh
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+## Deployment
+
+The site is deployed to GitHub Pages via CI. The production build is triggered by pushing to `main`.
+
+To build and preview locally:
+
+```bash
+pnpm build && pnpm serve
+```