Files
poky/documentation/index.rst
Antonin Godard ced8ad236d index.rst: move the "Overview and Concepts" manual in the "Introduction and Overview" section
The Overview and Concepts manual contains introductory content which
feels like it should rather be in the first section of the welcome page,
rather than the "Manuals" section. Moreover, this section does not feel
like a manual either, so rename the section title to "Overview and
Concepts". Keep the "-manual" suffix to the directory name to avoid
breaking links, though.

(From yocto-docs rev: f1ab418602aefbde6ca46cfe01ee0695a9c91d65)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 62b982ca545441657491f4d8553144cef7cb3185)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-08-24 14:26:36 +01:00

103 lines
2.7 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
.. The Yocto Project documentation master file, created by
sphinx-quickstart on Mon Apr 13 09:38:33 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==========================================
Welcome to the Yocto Project Documentation
==========================================
This is the top level of the Yocto Project documentation tree. The Yocto Project
documentation is always a work in progress, just like the Yocto Project itself.
Improvements to the documentation are always welcome; join the
:yocto_lists:`docs mailing list </g/docs>` if you want to help out.
Introduction and Overview
=========================
Get started using the Yocto Project.
.. toctree::
:maxdepth: 1
:caption: Introduction and Overview
Quick Build <brief-yoctoprojectqs/index>
what-i-wish-id-known
transitioning-to-a-custom-environment
Yocto Project Technical Overview <https://www.yoctoproject.org/development/technical-overview/>
Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks>
Get familiar with the development environment and concepts of the Yocto Project.
.. toctree::
:maxdepth: 2
Overview and Concepts <overview-manual/index>
Contributing to the Yocto Project
=================================
Guides on how to contribute to the different parts of the Yocto Project.
.. toctree::
:maxdepth: 2
:caption: Contributor Guide
Contributor Guide <contributor-guide/index>
Manuals
=======
A collection of manuals covering many aspects of the Yocto Project, including
reference definitions, tutorials, and details about the project's
infrastructure.
.. toctree::
:maxdepth: 1
:caption: Manuals
Reference Manual <ref-manual/index>
Board Support Package (BSP) Developer's guide <bsp-guide/index>
Development Tasks Manual <dev-manual/index>
Linux Kernel Development Manual <kernel-dev/index>
Profile and Tracing Manual <profile-manual/index>
Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
Toaster Manual <toaster-manual/index>
Test Environment Manual <test-manual/index>
bitbake
Security Reference
==================
Security-related processes and contact information for vulnerability reporting.
.. toctree::
:maxdepth: 1
:caption: Security Reference
Yocto Project Security Reference <security-reference/index>
.. toctree::
:maxdepth: 1
:caption: Release Manuals
:hidden:
Release Information <migration-guides/index>
releases
.. toctree::
:maxdepth: 1
:caption: Documentation Index
:hidden:
genindex
.. toctree::
:maxdepth: 1
:caption: Documentation Downloads
:hidden:
downloads