[libcamera-devel] Documentation: Update more detail developer guide on official site
Laurent Pinchart
laurent.pinchart at ideasonboard.com
Tue Mar 29 14:12:36 CEST 2022
On Tue, Mar 29, 2022 at 08:37:18PM +0900, Kwang Son wrote:
> On Tue, Mar 29, 2022 at 01:17:09PM +0300, Laurent Pinchart wrote:
> > On Tue, Mar 29, 2022 at 07:39:01AM +0200, Jean-Michel Hautbois via libcamera-devel wrote:
> > > On 29/03/2022 04:46, Kwang Son via libcamera-devel wrote:
> > > > Currently I search document from official site[1] and
> > > > it's less detail compared to own build sphinx document.
> > > > I think it will be great official documentation has sidebar, so official
> > > > site doc has more detail developer documentation.
> > > >
> > > > For now only show docs.rst
> > > > My idea is that make docs.rst to root of docs and has sub-child
> > > > docs - original docs content
> > > > - Application Guide
> > > > - Internal Dev Guide - Pipe, IPA, ...
> > >
> > > That's I think a common wish :-).
> > >
> > > >
> > > > This bring benefit that newbie like me easy to search dev information
> > > > without build document.
> > > > My concern is that official site use different css or javascript.
> > > > So I want to confirm that if I modified sphinx doc and it can be
> > > > transited to official site easily by administrator.
> > >
> > > If you post patches, they will be reviewed, and if it fits then you will
> > > see the doc updated when pushed to the master branch, as for all the
> > > other patches. It will certainly be updated on the official site ;-).
> >
> > The thing is that the guides are not integrated in the website, and
> > that's not part of the libcamera repository. We need some web design
> > efforts to reorganize the contents. Without the website repo being
> > public, patches can't be sent.
>
> I understand that documentation to website needs to be clear and better
> design. But sadly I created path before I read this mail..
> I'll put patch as RFC, simply someone can reference when they need.
> If still can't accept, simply ignore patch.
We will review it :-) Thank you for your contribution.
> > > Please send patches !
> > >
> > > > [1] https://www.libcamera.org/docs.html
--
Regards,
Laurent Pinchart
More information about the libcamera-devel
mailing list