documentation/content/developer.rst
Antoine Vandevenne (anv) 57b7ca69d9 [IMP] developer: improve navigation in top-level pages
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.

This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
  main categories of developer documentation ("Tutorials", "How-to
  guides", and "Reference") with explanations of their content and
  target audience;
- add categories for content cards on the "Tutorials" and "How-to
  guides" pages, and fine-tune the toctree of the "Reference" page to
  more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
  by relabelling them to "Server framework" and "Web framework" on
  top-level pages, as some users were confused to find that the JS
  framework was not responsible for the server, and others that the
  documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
  rename the latter to "Server framework 101" to allow reusing the setup
  guide in other tutorials and make clear that the "Server framework 101"
  tutorial is not about the Web framework.

task-3802536

closes odoo/documentation#8712

X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-13 12:16:35 +00:00

48 lines
1.6 KiB
ReStructuredText

:show-content:
:hide-page-toc:
=========
Developer
=========
.. toctree::
developer/tutorials
developer/howtos
developer/reference
Welcome to the developer documentation of Odoo! Whether you're a seasoned developer or just getting
started, you'll find here all the technical guidance and resources you need for developing Odoo
applications. Explore our extensive collection of tutorials, how-to guides, and reference materials
to achieve your development goals.
The Odoo development ecosystem is built on a modular and extensible architecture that allows you
to extend existing applications or create new ones to meet the specific needs of modern businesses.
You can make use of the tools and frameworks provided by Odoo to focus on getting your web
application up and running quickly, without needing to reinvent the wheel and worry about the
underlying infrastructure.
If you are new to Odoo or web application development, start with the
:doc:`developer/tutorials/server_framework_101` tutorial.
.. cards::
.. card:: Tutorials
:target: developer/tutorials
Tutorials take you by the hand through hands-on exercises to build skills and familiarity in
Odoo development.
.. card:: How-to guides
:target: developer/howtos
Recipes that provide a step-by-step guide for addressing real-world problems and use-cases.
.. card:: Reference
:target: developer/reference
Technical descriptions and factual information on the frameworks and APIs of Odoo.
.. seealso::
- :doc:`Guide: Contribute to the codebase </contributing/development>`
- `Community forums <https://www.odoo.com/forum>`_