[RFC/PATCH,1/3] Documentation: Reorganize the index of the "For Developers" section
diff mbox series

Message ID 20260126190141.2410546-2-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Documentation: Explain libcamera's policy on dependencies
Related show

Commit Message

Laurent Pinchart Jan. 26, 2026, 7:01 p.m. UTC
The section of the index aimed at developers starts with the
contribution guide, and only lists the libcamera architecture page
futher down. Reorganize it to start with the "getting starting" page,
which, as its name implies, is meant to be a good entry point, and
continue with the architecture and guides before the more specialized
documentation.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/index.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Stefan Klug June 9, 2026, 3:57 p.m. UTC | #1
Hi Laurent,

Thank you for the patch.

Quoting Laurent Pinchart (2026-01-26 20:01:39)
> The section of the index aimed at developers starts with the
> contribution guide, and only lists the libcamera architecture page
> futher down. Reorganize it to start with the "getting starting" page,
> which, as its name implies, is meant to be a good entry point, and
> continue with the architecture and guides before the more specialized
> documentation.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/index.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 8109b4295c92..03c3d0b4aff6 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -19,12 +19,12 @@
>     :maxdepth: 1
>     :caption: For Developers
>  
> -   Contribute <contributing>
>     Getting Started <getting-started>
> -   Camera Sensor Model <camera-sensor-model>
> -   IPA Writer's guide <guides/ipa>
> -   libcamera Architecture <libcamera_architecture>
> +   Architecture <libcamera_architecture>
>     Pipeline Handler Writer's Guide <guides/pipeline-handler>
> +   IPA Writer's guide <guides/ipa>
> +   Contribute <contributing>
> +   Camera Sensor Model <camera-sensor-model>

I think I would have put the Contribute page either at the end or after
the getting started as it is a bit of an outlier. But I don't care too
much.

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>

>     SoftwareISP Benchmarking <software-isp-benchmarking>
>     Tracing guide <guides/tracing>
>     Design document: AE <design/ae>
> -- 
> Regards,
> 
> Laurent Pinchart
>
Laurent Pinchart June 9, 2026, 4:21 p.m. UTC | #2
On Tue, Jun 09, 2026 at 05:57:17PM +0200, Stefan Klug wrote:
> Quoting Laurent Pinchart (2026-01-26 20:01:39)
> > The section of the index aimed at developers starts with the
> > contribution guide, and only lists the libcamera architecture page
> > futher down. Reorganize it to start with the "getting starting" page,
> > which, as its name implies, is meant to be a good entry point, and
> > continue with the architecture and guides before the more specialized
> > documentation.
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >  Documentation/index.rst | 8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > index 8109b4295c92..03c3d0b4aff6 100644
> > --- a/Documentation/index.rst
> > +++ b/Documentation/index.rst
> > @@ -19,12 +19,12 @@
> >     :maxdepth: 1
> >     :caption: For Developers
> >  
> > -   Contribute <contributing>
> >     Getting Started <getting-started>
> > -   Camera Sensor Model <camera-sensor-model>
> > -   IPA Writer's guide <guides/ipa>
> > -   libcamera Architecture <libcamera_architecture>
> > +   Architecture <libcamera_architecture>
> >     Pipeline Handler Writer's Guide <guides/pipeline-handler>
> > +   IPA Writer's guide <guides/ipa>
> > +   Contribute <contributing>
> > +   Camera Sensor Model <camera-sensor-model>
> 
> I think I would have put the Contribute page either at the end or after
> the getting started as it is a bit of an outlier. But I don't care too
> much.

I think we need to further refactor the documentation as the second half
of the entries looks more like a bunch of losely-connected information.

I'll move the Contribute section to the end.

> Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>
> 
> >     SoftwareISP Benchmarking <software-isp-benchmarking>
> >     Tracing guide <guides/tracing>
> >     Design document: AE <design/ae>

Patch
diff mbox series

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 8109b4295c92..03c3d0b4aff6 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -19,12 +19,12 @@ 
    :maxdepth: 1
    :caption: For Developers
 
-   Contribute <contributing>
    Getting Started <getting-started>
-   Camera Sensor Model <camera-sensor-model>
-   IPA Writer's guide <guides/ipa>
-   libcamera Architecture <libcamera_architecture>
+   Architecture <libcamera_architecture>
    Pipeline Handler Writer's Guide <guides/pipeline-handler>
+   IPA Writer's guide <guides/ipa>
+   Contribute <contributing>
+   Camera Sensor Model <camera-sensor-model>
    SoftwareISP Benchmarking <software-isp-benchmarking>
    Tracing guide <guides/tracing>
    Design document: AE <design/ae>