Platform Mesh Website

This is the repository backing the website of the Platform Mesh project.

The documentation follows the Diátaxis framework, organised into four sections:

• Tutorials (tutorials/) — guided, learning-oriented walkthroughs.
• How-to guides (how-to-guides/) — task-oriented recipes for specific goals.
• Concepts (concepts/) — explanation-oriented background on the architecture.
• Reference (reference/) — fact-oriented lookup for components and resources.

Contributing

We welcome contributions to the Platform Mesh website! If you have suggestions, improvements, or bug fixes, please follow these steps:

1. Fork the repository
2. Create a new branch for your changes
3. Make your changes and commit them with a clear message
4. Test your changes locally:

   npm install
   npm run dev  # Development server at http://localhost:5173
   
   # Or test with versioning:
   DOCS_VERSION=main npm run build
   npm run preview  # Preview at http://localhost:4173/main/

5. Push your changes to your fork
6. Create a pull request against the main branch of this repository

Deployment (local and github)

For detailed documentation on versioning, local testing, and GitHub Pages deployment, see the documentation:

• Deployment How-To Guide - Complete guide for local testing, version switching, and deploying to GitHub Pages
• Verifying Deployment - Step-by-step verification checklist and troubleshooting

Diagrams

Diagrams are done excalidraw and can be found here (read-only link): https://link.excalidraw.com/readonly/NGxHb0Dkpp1pZKTFeW1h?darkMode=true