Documentation Web Site
The documentation web site is managed using Github pages. This is done using a special branch in the repository named gh-pages.
The web site is based on Twitter Bootstrap and Angular.js. Updates of the content are achieved by merging the master branch of this repository with the gh-pages branch. Github automatically updates the web site when changes are merged in the gh-pages branch.
The following graph should help you understand the structure of the gh-pages branch.
joomla-developer-docs
|- css // CSS for the web site.
|- docs // Source documentation files from the `master` branch.
| `- en // The language base.
| |- home.md // This file controls the content for the 'home' page.
| `- menu.md // This file control the content of the left-hand menu.
|- img // Image resources for the web site template.
|- js // Bootstrap and Angular application JavaScript files for the web site.
|- partials // Partial templates for Angular.
|- .gitignore // A special git file from the `master` branch.
|- CONTRIBUTING.md // A file from the `master` branch.
|- index.html // The landing page for the web site.
|- index-async.html // ?
`- README.md
When making changes to the web site, do not edit any files that come from the master branch (like anything under /docs/). Note that left-hand menu of the web site is automatically generated from the /docs/en/menu.md file.
If you want to help style the web site, you will need to fork this repository and make changes to the gh-pages branch. Commit those changes and then submit a pull request for review.
If you want to help with the content of the web site, then you need to make changes against a copy of the master branch (the content is written in Github flavoured Markdown).