docs: Prepared Home, Dev Guide and About sections

[o-kopysov]

Pull Request

Description

Current PR contains the first portion of changes in GH Pages documentation.
MkDocs will be used for converting MD -> HTML static pages.

Structure of the website:

• Home: index.md
• Getting Started: getting-started.md
• User Guide: TBD
• Developer Guide:
  • Developer guide: dev-guide/README.md
  • Contributing guide: dev-guide/contributing.md
  • Testing policy: dev-guide/testing_policy.md
  • Code review requirements: dev-guide/code-review-requirements.md
  • API reference: dev-guide/api.md
  • Integration guide: dev-guide/integration.md
• About:
  • License: about/license.md
  • Releases: about/releases.md

Bold means that pages are included in this pull request.

Home:

Dev Guide:

About

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Code cleanup/refactoring
• Documentation update
• This change requires a documentation update
• CI system update
• Test Coverage update

Testing

Install required dependencies:

$ pip install mkdocs
$ pip install mkdocs-material

Run MkDocs:

$ cd doc
$ mkdocs serve

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.67%. Comparing base (8a15ef5) to head (8c593ed).

Additional details and impacted files

@@            Coverage Diff            @@
##               main     #592   +/-   ##
=========================================
  Coverage     93.67%   93.67%           
  Complexity      608      608           
=========================================
  Files            49       49           
  Lines          2104     2104           
  Branches        244      244           
=========================================
  Hits           1971     1971           
  Misses           61       61           
  Partials         72       72           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[t-naumenko]

Great start of documentation improvement!

[o-konoval]

Great job! Modern look of documentation is very important part of repository. Approved!