<commit_before># __package-name__

This is where your project documentation should go. It SHOULD NOT just be a
repetition of the README, but COULD expand on some of the topics mentioned
there. The primary focus SHOULD be on someone wanting to make use of the
software/library rather than someone wanting to develop on it.

The index page SHOULD be a brief introduction. All other sections SHOULD be
separate pages, linked together via the mkdocs configuration.

Some things to consider:

- Introduction
  - What it is
  - Why it exists
  - How to obtain it
  - Requirements
  - Installation steps
- Quickstart.
  - ie. what's the quickest way for someone to get up and running,
    covering the most common use cases.
- Architecture
- Configuration
- Different use cases
- Deeper dive into individual features/components
- Limitations
- Any relevant history
- How to get help
- FAQ

Some third party documentation for inspiration:

- [Guzzle](http://docs.guzzlephp.org/en/stable/)
- [Doctrine DBAL](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/)
- [CLImate](https://climate.thephpleague.com/)
- [Respect Validation](https://respect.github.io/Validation/)<commit_msg>Fix indentation level needed by mkdocs<commit_after># __package-name__

This is where your project documentation should go. It SHOULD NOT just be a
repetition of the README, but COULD expand on some of the topics mentioned
there. The primary focus SHOULD be on someone wanting to make use of the
software/library rather than someone wanting to develop on it.

The index page SHOULD be a brief introduction. All other sections SHOULD be
separate pages, linked together via the mkdocs configuration.

Some things to consider:

- Introduction
    - What it is
    - Why it exists
    - How to obtain it
    - Requirements
    - Installation steps
- Quickstart.
    - ie. what's the quickest way for someone to get up and running,
      covering the most common use cases.
- Architecture
- Configuration
- Different use cases
- Deeper dive into individual features/components
- Limitations
- Any relevant history
- How to get help
- FAQ

Some third party documentation for inspiration:

- [Guzzle](http://docs.guzzlephp.org/en/stable/)
- [Doctrine DBAL](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/)
- [CLImate](https://climate.thephpleague.com/)
- [Respect Validation](https://respect.github.io/Validation/)
{'fraction_non_alphanumeric': 0.07453416149068323, 'fraction_numerical': 0.0, 'mean_word_length': 3.7936507936507935, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6907356', 'n_tokens_mistral': 688, 'n_tokens_neox': 651, 'n_words': 286}