Repository files navigation

This repository is for both the site, and content, ofBolt, and shouldbe considered a counterpart of theBolt repository.

The documentation uses theMarkdown format. There is no need tobuild anything to generate HTML. We parse the markdown with PHP.

Since this repository is set up to use git's worktree feature, it is advisedwith to use git version 2.5 or later.

The repository uses branches to group documentation relevant to each version inthe format ofrelease/<version>.

Changes should be PR-ed against thelowest relevant version and will then bemerged down into higher version branches as required.

e.g. if you're fixing a typo that exists in the same Markdown file in bothversion 3.0 as well as in 3.1, you would checkoutrelease/3.0 and submit yourPR against that branch.

To run the site locally you need to complete the following steps:

• Create the repository withgit clone
• Create worktrees for required versions
• Runcomposer update to install required vendor libraries

An example that sets up work trees for 2.2, 3.0 and 3.1 is:

git clone git@github.com:bolt/docs.git bolt-docscd bolt-docsgit checkout sitegit worktree add var/versions/2.2 origin/release/2.2git worktree add var/versions/3.0 origin/release/3.0git worktree add var/versions/3.1 origin/release/3.1composer update

For your local environment you can add a configuration file, located atapp/config.yml to facilitate local development. It should contain thefollowing:

debug:truedefault-version:'3.1'

Note: If you want to set it to3.0 for example, be sure to include thequotes. Otherwise the YML parser will interpret it as3.

Finally if you wish to use the built-in PHP web server, it can be run from thebolt-docs/ folder, pointing toweb/ as the document root.

php -S 0.0.0.0:8000 -t web web/index.php

Alternatively, configure your preferred webserver to point at theweb/folder. To see the documentation site go toexample.localhost/3.1/, fromwhere you'll get redirected to the front page of the documentation.