mbox series

[0/9] Rework the docs.yoctoproject.org welcome page

Message ID 20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com
Headers show
Series Rework the docs.yoctoproject.org welcome page | expand

Message

Antonin Godard July 24, 2026, 1:24 p.m. UTC 
The current Yocto Project documentation welcome page only contains a
table of contents which is not very approachable. This series aims at
making it a more helpful welcome page, but also goes further down the
documents to organize them in a more coherent way.

This does not break existing links apart from the bsp-guide which was
renamed to bsp-manual.

You can preview the changes here: https://docs.yoctoproject.org/next/

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (9):
      index.rst: add introduction paragraphs
      index.rst: move the contributor guide out of the Manuals section
      index.rst: move the "Overview and Concepts" manual in the "Introduction and Overview" section
      index.rst: move external links to the bottom of the intro section
      overview-manual: move the intro content in the index
      bsp-guide: rename to bsp-manual
      contributor-guide/identify-component.rst: use the same tense as other section
      bitbake.rst: rename section to "BitBake User Manual"
      index.rst: move release notes in their own section

 documentation/README                               |   8 +--
 documentation/bitbake.rst                          |   6 +-
 documentation/bsp-guide/index.rst                  |  15 -----
 documentation/{bsp-guide => bsp-manual}/bsp.rst    |  34 +++++-----
 .../figures/bsp-dev-flow.png                       | Bin
 documentation/bsp-manual/index.rst                 |  15 +++++
 .../contributor-guide/identify-component.rst       |   4 +-
 documentation/dev-manual/layers.rst                |   4 +-
 documentation/dev-manual/new-machine.rst           |   2 +-
 documentation/dev-manual/start.rst                 |   2 +-
 documentation/dev-manual/upgrading-recipes.rst     |   2 +-
 documentation/index.rst                            |  68 +++++++++++++++++---
 documentation/kernel-dev/advanced.rst              |   2 +-
 documentation/kernel-dev/common.rst                |   6 +-
 documentation/migration-guides/migration-2.5.rst   |   2 +-
 documentation/overview-manual/concepts.rst         |   2 +-
 .../overview-manual/development-environment.rst    |   4 +-
 documentation/overview-manual/index.rst            |  59 +++++++++++++++++-
 documentation/overview-manual/intro.rst            |  69 ---------------------
 documentation/overview-manual/yp-intro.rst         |   4 +-
 documentation/ref-manual/faq.rst                   |   6 +-
 documentation/ref-manual/resources.rst             |   2 +-
 documentation/ref-manual/structure.rst             |   2 +-
 documentation/ref-manual/terms.rst                 |   4 +-
 documentation/sphinx-static/theme_overrides.css    |   4 ++
 documentation/standards.md                         |   6 +-
 .../transitioning-to-a-custom-environment.rst      |   2 +-
 documentation/what-i-wish-id-known.rst             |   6 +-
 28 files changed, 190 insertions(+), 150 deletions(-)
---
base-commit: 358519ca6406a89fee42c45dcaf63a37a374f33c
change-id: 20260722-rework-welcome-page-a230bd12de45