Community mailing list archives

Re: Reflection about documentation.

Vauxoo S.A. de C.V., Nhomar Hernandez
- 08/13/2014 12:31:16
Fabien really thanks for answer.

On Wed, Aug 13, 2014 at 11:39 AM, Fabien Pinckaers <> wrote:
So, next steps:

1/ We will finish our technical doc and communicate on it as soon as
   it's ready to be published

2/ We created the "Community Translators" mailing list to start
   organising discussions and responsabilities amongst translators
      Join here:
      Write to:

3/ We will move our efforts on the technical doc to a separate
   repository with public write access. We initially put it in a
   odoo/odoo branch fork. But, for access rights, it's better to have
   all docs in a separate repository.

In this point, is good have all methods on the orm documented (it is a layer) and the external is the "how to helper guide", right?

IMHO a PR to the core fixing doc desn't bring too much problem, but I think all the api's:


__must__ be related to the code.

And the "How to's concepts and so on" on a section like what we have today here [1]
4/ Can someone contribute to restructure the existing documentation
   into a new and clean structure? If someone is ready to do this
   (around 20 hours of work), we can discuss together on how to do it.

5/ Once we will have the structure of the documentation, we will be
   able to assign responsibilities on writing / improving chapters. 
6/ We will clean the platform and add missing features from readthedoc
   but we will keep the design of bootstrap. (the only things we
   need is to connect transifex to the github repo and the Edit in
   Github button)


Nhomar Hernandez
CEO Vauxoo.
Twitter: @nhomar
Odoo Gold Partner