<commit_before># Developer Guidelines

Below some rules how to deal with documentations, linking or using the php docs.

## Documentation & Guide

Informations about creating guides and how they are rendered on luya.io:

+ Heading 1 titles will automatically removed from the rendering on luya.io, therefore the navigation title will be used instead. So you add a heading markdown notation on a file, but you don't have to.
+ Heading 2 titles will be used in order to auto generate a table of contents on luya.io.

In order to make a Link somewhere inside the Guide or PHPDoc to a PHP Class use:

+ `{{luya\base\Module}}` This will generate a link to the API for the given class name.
+ `{{luya\base\Module::$apis}}` Genrate a link to an API class with property `$apis`.
+ `{{luya\base\Module::resolveRoute()}}` Genrate a link to an API class with method `resolveRoute()`.

In order to make links from the API PHPdocs to the Guide use:

+ `[[concept-tags.md]]` where the markdown file is a file located in `/docs/guide` folder.

When dealing with Controller, Action and other PHP names use single quotes \`MyController\`. Like `MyController` is the file `MyController.php` with the action `indexAction()`, this is also for Variables `$foobar`.

### Wording

This represents a guideline how words and proper nouns should be written in the documentation.

+ LUYA - always capitalized
+ Composer 
+ AngularJS
+ NgRest
+ admin UI - instead of Admin, admin module or Admin UI
+ GitHub
+ API
+ OSX
+ PHP
+ HTML
+ DRY
+ CRUD
+ e.g. - instead of f.e., for example or similar expressions
+ yourdomain.com -- instead of example.com, yourproject.com, etc

Further it should be avoided to use personal pronouns (e.g. we have this, we recommed that, etc.), please use unpersonal pronouns ( e.g. there is this, it´s recommend that, etc.).


## PHPDOC

All classes must have a php doc block which is sorted as follow including author and since tag.

```php
/**
 * Title for the class with Dot.
 *
 * The description of the class should be available like this also with a dot at the end.
 *<commit_msg>Update luya-guideline.md (#1696)<commit_after># Developer Guidelines

Below some rules how to deal with documentations, linking or using the php docs.

## Documentation & Guide

Informations about creating guides and how they are rendered on luya.io:

+ Heading 1 titles will automatically removed from the rendering on luya.io, therefore the navigation title will be used instead. So you add a heading markdown notation on a file, but you don't have to.
+ Heading 2 titles will be used in order to auto generate a table of contents on luya.io.

In order to make a Link somewhere inside the Guide or PHPDoc to a PHP Class use:

+ `{{luya\base\Module}}` This will generate a link to the API for the given class name.
+ `{{luya\base\Module::$apis}}` Genrate a link to an API class with property `$apis`.
+ `{{luya\base\Module::resolveRoute()}}` Genrate a link to an API class with method `resolveRoute()`.

In order to make links from the API PHPdocs to the Guide use:

+ `[[concept-tags.md]]` where the markdown file is a file located in `/docs/guide` folder.

When dealing with Controller, Action and other PHP names use single quotes \`MyController\`. Like `MyController` is the file `MyController.php` with the action `indexAction()`, this is also for Variables `$foobar`.

### Wording

This represents a guideline how words and proper nouns should be written in the documentation.

+ LUYA - always capitalized
+ Composer 
+ AngularJS
+ NgRest
+ ActiveWindow
+ admin UI - instead of Admin, admin module or Admin UI
+ GitHub
+ API
+ OSX
+ PHP
+ HTML
+ DRY
+ CRUD
+ e.g. - instead of f.e., for example or similar expressions
+ yourdomain.com -- instead of example.com, yourproject.com, etc

Further it should be avoided to use personal pronouns (e.g. we have this, we recommed that, etc.), please use unpersonal pronouns ( e.g. there is this, it´s recommend that, etc.).


## PHPDOC

All classes must have a php doc block which is sorted as follow including author and since tag.

```php
/**
 * Title for the class with Dot.
 *
 * The description of the class should be available like this also with a dot at the end.
 *
{'fraction_non_alphanumeric': 0.08083689966714218, 'fraction_numerical': 0.0019020446980504042, 'mean_word_length': 3.978698224852071, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3922995', 'n_tokens_mistral': 1234, 'n_tokens_neox': 1160, 'n_words': 631}