From 0c19aa34913f2aa445ddd38811bce0887bcaf141 Mon Sep 17 00:00:00 2001 From: Bharath Chari Date: Mon, 20 Apr 2026 08:13:58 +0300 Subject: [PATCH] =?UTF-8?q?Update=20README=20=E2=80=94=20reflect=20editori?= =?UTF-8?q?al=20component=20system=20and=20JSON=20data=20files?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 85 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 56 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 4e6a8b9..dfee2f4 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,67 @@ -# Xahau website and documentation +# Xahau Website [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/Xahau/xahau-web/tree/main) [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/Xahau/xahau-web/tree/main) -## Project Structure +Built with [Astro](https://astro.build), [Tailwind CSS](https://tailwindcss.com), and [React](https://react.dev). Editorial pages use a hand-coded component system; documentation lives under `src/content/docs/` and is powered by [Starlight](https://starlight.astro.build). -Inside the project, these are the most relevant folders for collaboration - -```text -/ -├── public/ -├── src/ -│ └── assets/ -│ └── ecosystem-logos/ -│ └── content/ -│ └── docs/ -│ └── docs/ -│ └── pages/ -│ └── schemas/ -``` - -The project is using `.mdx` files for content, which combines markdown with JSX. When editing content, look at the existing files for reference on how various elements are used, such as `LinkButton`, `LinkCard`, `Aside` etc. +--- ## Commands -All commands are run from the root of the project, from a terminal: +| Command | Action | +| :---------------- | :-------------------------------------------- | +| `npm install` | Install dependencies | +| `npm run dev` | Start local dev server at `localhost:4321` | +| `npm run build` | Build production site to `./dist/` | +| `npm run preview` | Preview production build locally | +| `npm run check` | Auto-fix formatting with Biome | +| `npm run ci` | Biome lint check (CI — no auto-fix) | -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | +--- -## Standards for Formatting Contributions +## Project Structure -When contributing, please adhere to the standards defined in "[contributing.md](contributing.md)". +``` +/ +├── public/ Static assets (fonts, favicons) +├── src/ +│ ├── assets/ SVGs, images, gem PNGs +│ ├── components/ Astro & React components +│ ├── content/docs/ Starlight documentation (Markdown/MDX) +│ ├── data/ JSON data files — edit these to update content +│ ├── i18n/ Translation keys for the home page +│ ├── layouts/ Page-level layout wrappers +│ ├── pages/ URL routes (en = root, es/, ja/) +│ └── styles/ Global CSS and Tailwind theme tokens +├── biome.jsonc Linter/formatter config (Biome 2.4) +└── astro.config.mjs Astro config (i18n, integrations) +``` + +--- + +## Localization + +The site supports three locales: English (root `/`), Spanish (`/es/`), and Japanese (`/ja/`). Each editorial page has a dedicated component per locale — e.g. `XahauAbout.astro`, `XahauAboutEs.astro`, `XahauAboutJa.astro` — with a thin `.astro` page wrapper in `src/pages/` for each. + +--- + +## Updating Content + +Most editorial page content is stored in JSON files under `src/data/`. **Edit the JSON to change what's rendered — no component code changes needed.** See [DEVELOPMENT.md](DEVELOPMENT.md) for the full schema of each file. + +| File | Controls | +| :--- | :------- | +| `src/data/home.json` | Statistics tiles on the home page | +| `src/data/about.json` | All copy and section structure on the About page | +| `src/data/features.json` | Feature cards and body copy on the Features page | +| `src/data/connect.json` | Events list on the Connect page | +| `src/data/roadmap.json` | Roadmap items and quarter window | +| `src/data/ecosystem.json` | Ecosystem project list | + +--- + +## Further Reading + +- [DEVELOPMENT.md](DEVELOPMENT.md) — editorial component system, design tokens, JSON schemas, Biome config +- [CONTRIBUTING.md](CONTRIBUTING.md) — code style and pull request guidelines