index.md 1.17 KB
Newer Older
Michal Maciejewski's avatar
Michal Maciejewski committed
1 2 3
# Signal Monitoring Documentation

In this website we store user documentation of the LHC Signal Monitoring project. 
Michal Maciejewski's avatar
Michal Maciejewski committed
4
The website is divided into nine subpages with useful information about the project:
5

Michal Maciejewski's avatar
Michal Maciejewski committed
6
1. **Overview** - project overview with links to the main project repositories
7
2. **API Documentation** - a link to the API documentation auto-generated from code
Michal Maciejewski's avatar
Michal Maciejewski committed
8 9 10
3. **API User Guide** - an extensive user guide with numerous code examples of key API modules
4. **HWC&FPA Notebooks** - a description on how to use HWC and FPA notebooks
5. **HWC&FPA Circuits** - a list of supported notebooks for HWC and FPA
Michal Maciejewski's avatar
Michal Maciejewski committed
11 12 13 14
6. **Project Conventions** - a set of main project conventions followed during the development
7. **Development Process** - information on how the project is developed
8. **Help** - information on where to look for help
9. **FAQ** - a growing summary of frequently asked questions
Michal Maciejewski's avatar
Michal Maciejewski committed
15 16 17

For more information about the project itself, please visit [https://cern.ch/sigmon](https://cern.ch/sigmon).

18 19
We suggest to use the site `Search` feature in the top bar to look for a specific keyword.

Michal Maciejewski's avatar
Michal Maciejewski committed
20
The platform is based on mkdocs + GitLab. To edit this site just click the pencil symbol at the top-right.