[1/2] Documentation: Fix link to introduction on mainpage.dox
diff mbox series

Message ID 20240822081607.911049-2-dan.scally@ideasonboard.com
State Accepted
Commit 8c1b29072e7b7fdb365e85ea654c3b0ed0b69350
Headers show
Series
  • Fixed Documentation links
Related show

Commit Message

Dan Scally Aug. 22, 2024, 8:16 a.m. UTC
With the removal of guides/introduction.rst the link on the API
reference landing page no longer works. Point it to the documents
introduction page instead.

Fixes: 860a3e30 ("Documentation: Rework docs.rst into introduction.rst")
Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
---
 Documentation/mainpage.dox | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Laurent Pinchart Aug. 25, 2024, 1:27 a.m. UTC | #1
Hi Dan,

Thank you for the patch.

On Thu, Aug 22, 2024 at 09:16:06AM +0100, Daniel Scally wrote:
> With the removal of guides/introduction.rst the link on the API
> reference landing page no longer works. Point it to the documents
> introduction page instead.
> 
> Fixes: 860a3e30 ("Documentation: Rework docs.rst into introduction.rst")
> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/mainpage.dox | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox
> index d5a57653..d04d932f 100644
> --- a/Documentation/mainpage.dox
> +++ b/Documentation/mainpage.dox
> @@ -5,7 +5,7 @@ Welcome to the API reference for <a href="https://libcamera.org/">libcamera</a>,
>  a complex camera support library for Linux, Android and ChromeOS. These pages
>  are automatically generated from the libcamera source code and describe the API
>  in detail - if this is your first interaction with libcamera then you may find
> -it useful to visit the [developer's guide](../html/guides/introduction.html) in
> +it useful to visit the [documentation](../introduction.html) in
>  the first instance, which can provide a more generic introduction to the
>  library's concepts.
>

Patch
diff mbox series

diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox
index d5a57653..d04d932f 100644
--- a/Documentation/mainpage.dox
+++ b/Documentation/mainpage.dox
@@ -5,7 +5,7 @@  Welcome to the API reference for <a href="https://libcamera.org/">libcamera</a>,
 a complex camera support library for Linux, Android and ChromeOS. These pages
 are automatically generated from the libcamera source code and describe the API
 in detail - if this is your first interaction with libcamera then you may find
-it useful to visit the [developer's guide](../html/guides/introduction.html) in
+it useful to visit the [documentation](../introduction.html) in
 the first instance, which can provide a more generic introduction to the
 library's concepts.