Make sure you have Nix installed. You may also want to configure the Spectrum binary cache, to avoid having to wait for dependencies to compile on your local system.
Get a copy of the Spectrum source code:
git clone https://spectrum-os.org/git/spectrum
Enter the documentation directory:
Enter the development environment:
nix-shell -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz
In the development shell, do an initial build of the documentation site:
Run a development server for previewing changes locally:
This will serve a local copy of the documentation at http://localhost:4000/.Important
Jekyll does not handle rendering of the draw.io diagrams. If you modify any of those, or add new ones, run
scripts/build.shagain to do a full rebuild of the site.
After making changes to the documentation, see how to send your patch and submit the changes for review.