Newer
Older
The purpose of this project is to provide a central entry point for all Rocket.Chat projects' documentation and general documentation contribution, structure and style guides.
## Site structure
Above all else, this portal strives to keep everything simple and easy to use.
We chose Jekyll and GitLab pages because together they offer the most supported and user friendly way for others to fork, edit, preview and contribute documentation without having to setup a local development environment just to write copy, add images or manage files.
For developers, only use templates and includes when they are needed. Creating a template per page or splitting templates into many parts that are only included ones makes it challenging to maintain and contribute to the project.
### Templates
The `default.html` template is the base template used by pages or other templates (only `post.html` at the moment).
Only create a Template if it will be used by more than one page. Rather add the structure and content to the page e.g. see `index.html`.
Like Templates, only create an Include if it will be used in more than one Template.
When changing styles, bump the `version` number in `config.yml` to force browsers to load the new version.
Define Template or Page styles in their own file with the same name as the Template or Page (e.g `_templates/default.html`) and then include the style in `styles.scss`.
Only define variables for values that are used in multiple places and need to vary. Use contextually relevant names instead of calling it by the current value it holds e.g use `$body-color` instead of `$color-light-blue`. If you change the value of the variable in the second case, you have to update the name and everywhere it is referenced.
Lists Rocket.Chat projects defined in `/_data/projects.yml` and outlines how to contribute.
### news.html
WIP: Index page for all documentation news.
### guies/*
Ideal documentation contributing, structure and style guides for all Rocket.Chat projects.