[PATCH i-g-t v3 2/3] docs: Initialize MkDocs documentation structure

Kamil Konieczny kamil.konieczny at linux.intel.com
Thu Aug 21 15:06:26 UTC 2025


Hi Pawel,
On 2025-08-20 at 07:29:33 +0200, Pawel Sikora wrote:
> This commit establishes the groundwork for a comprehensive
> documentation site, enhancing accessibility and organization.
> 
>  * Update README with basic content, reflecting
>    the reorganization of documentation files.
>  * Move detailed documentation into the docs directory,
>    splitting content across multiple markdown files.
>  * Set up the structure for automatic site generation using MkDocs,
>    facilitating easier navigation and maintenance.
> 
> v2:
>  - Add new content and make corrections (Swati)
>  - Fix line width to 100 characters (Kamil)
>  - Fix moved/copied files (Kamil)
> 
> Co-authored-by: Swati Sharma <swati2.sharma at intel.com>
> Reviewed-by: Swati Sharma <swati2.sharma at intel.com>
> Reviewed-by: Kamil Konieczny <kamil.konieczny at linux.intel.com>

Please remove both r-b, this should be explicitly given by
e-mail or irc or other ways.

> Signed-off-by: Pawel Sikora <pawel.sikora at linux.intel.com>
> ---
>  README.md                            |  203 +---
>  docs/CONTRIBUTING.md                 |   91 ++
>  docs/MAINTAINERS.md                  |   16 +
>  docs/NEWS.md                         | 1471 ++++++++++++++++++++++++++

As discussed offline, please add only symlinks in docs/
to original files.

Regards,
Kamil

>  docs/api.md                          |   30 +
>  docs/blocklists.md                   |  387 +++++++
>  docs/building.md                     |   27 +
>  docs/{chamelium.txt => chamelium.md} |    2 +-
>  docs/ci_infrastructure.md            |  419 ++++++++
>  docs/cross-building.md               |  240 +++++
>  docs/cross-building.txt              |  122 ---
>  docs/faq.md                          |   92 ++
>  docs/new_driver.md                   |  230 ++++
>  docs/overview.md                     |  249 +++++
>  docs/patchwork.md                    |   18 +
>  docs/running_tests.md                |  130 +++
>  docs/test_categories.md              |  266 +++++
>  docs/test_plan.md                    |  216 ++++
>  docs/mkdocs.yml => mkdocs.yml        |    2 +
>  19 files changed, 3914 insertions(+), 297 deletions(-)
>  create mode 100644 docs/CONTRIBUTING.md
>  create mode 100644 docs/MAINTAINERS.md
>  create mode 100644 docs/NEWS.md
>  create mode 100644 docs/api.md
>  create mode 100644 docs/blocklists.md
>  create mode 100644 docs/building.md
>  rename docs/{chamelium.txt => chamelium.md} (99%)
>  create mode 100644 docs/ci_infrastructure.md
>  create mode 100644 docs/cross-building.md
>  delete mode 100644 docs/cross-building.txt
>  create mode 100644 docs/faq.md
>  create mode 100644 docs/new_driver.md
>  create mode 100644 docs/overview.md
>  create mode 100644 docs/patchwork.md
>  create mode 100644 docs/running_tests.md
>  create mode 100644 docs/test_categories.md
>  create mode 100644 docs/test_plan.md
>  rename docs/mkdocs.yml => mkdocs.yml (98%)
> 
[cut]


More information about the igt-dev mailing list