mirror of
https://github.com/Xahau/xahau-web.git
synced 2025-11-04 12:15:49 +00:00
c25e8f7c57
* Remove extra section from Infrastructure sidebar in the documentation. Also remove cabbit.tech hubs. * Expand details on running a mainnet node. * Combine mainnet and testnet node install instructions to a single page. * Update system requirements. * Edit system requirements again. * Add placeholders for new documentation and contributing guidelines. * Update header, footer, and IndexLayout links to reflect renaming the infrastructure page to 'system-requirements'. * Fix overwrite from upstream index page layout. Add intro paragraph to running xahaud page. * Describe different types of nodes, expand contributing.md * Minor editing and revisions. * Additional guidelines added. * Add a placeholder page for 'Updating xahaud'. * Edited install/system requirements/updating. * Add instructions for updating Docker containers. * Add updating local install instructions. * Add background on enabling validation. * Add instructions on running xahaud as a validator. * Minor revisions to enabling validations and interacting with xahaud * Fixed minor typos and added formatting to the interacting.mdx webpage. * Add master example xahaud.cfg file to table on install page.
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# Xahau website and documentation
|
|
|
|
[](https://stackblitz.com/github/Xahau/xahau-web/tree/main)
|
|
[](https://codesandbox.io/p/sandbox/github/Xahau/xahau-web/tree/main)
|
|
|
|
## Project Structure
|
|
|
|
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` | 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
|
|
|
|
When contributing, please adhere to the standards defined in "[contributing.md](contributing.md)".
|