This repository contains the official documentation for Grid, a privacy-first location sharing app. The documentation is built using Docusaurus 2, a modern static website generator.
- Node.js version 18 or above
- npm (comes with Node.js)
# Clone the repository
git clone /~https://github.com/Rezivure/Grid-Docs.git
cd Grid-Docs
# Install dependencies
npm install# Start the development server
npm run startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
# Build the static files
npm run buildThis command generates static content into the build directory and can be served using any static content hosting service.
The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.
Grid-Docs/
├── docs/ # Documentation markdown files
│ ├── intro.md # Introduction page
│ └── ... # Other documentation files
├── src/
│ ├── components/ # React components
│ ├── css/ # CSS files
│ └── pages/ # Custom pages
├── static/ # Static files like images
├── docusaurus.config.js # Docusaurus configuration
├── sidebars.ts # Sidebar configuration
└── package.json
We welcome contributions to improve the documentation! Please read our Contributing Guidelines before submitting changes.
- Fork the repository
- Create your feature branch (
git checkout -b feature/improvement) - Commit your changes (
git commit -am 'Add some improvement') - Push to the branch (
git push origin feature/improvement) - Create a new Pull Request
- Use clear, concise language
- Include code examples where applicable
- Keep privacy and security in mind
- Update the sidebar when adding new pages
- Test all code examples
- Include screenshots for UI-related documentation
This documentation is licensed under AGPL-3.0. See the LICENSE file for details.
If you need help with the documentation:
- Join our Matrix chat
- Visit our website