[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#8597

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
This commit is contained in:
Antoine Vandevenne (anv)
2024-04-09 11:54:08 +02:00
parent 522f54cc43
commit 7f623b6ad5
111 changed files with 424 additions and 363 deletions
+31 -21
View File
@@ -6,42 +6,52 @@ Tutorials
=========
.. toctree::
:titlesonly:
tutorials/setup_guide
tutorials/server_framework_101
tutorials/discover_js_framework
tutorials/master_odoo_web_framework
tutorials/define_module_data
tutorials/restrict_data_access
tutorials/unit_tests
tutorials/mixins
tutorials/pdf_reports
tutorials/getting_started
tutorials/discover_js_framework
tutorials/master_odoo_web_framework
tutorials/define_module_data
tutorials/restrict_data_access
tutorials/unit_tests
tutorials/mixins
tutorials/pdf_reports
.. tip::
If you are new to Odoo development, we recommend starting with the :doc:`setup guide
<tutorials/setup_guide>`.
Learn the server and web frameworks
===================================
.. cards::
.. card:: Getting started
:target: tutorials/getting_started
.. card:: Server framework 101
:target: tutorials/server_framework_101
:tag: Beginner
:large:
Develop your own module with the Odoo framework. This step-by-step tutorial is crafted for
newcomers and any other individual curious about Odoo development.
This introductory tutorial is designed for complete beginners seeking to get started in Odoo
development. It covers the essential aspects and key concepts of the server framework. Learn
to create a simple module from scratch with step-by-step instructions and practical insights.
.. card:: Discover the JavaScript Framework
.. card:: Discover the web framework
:target: tutorials/discover_js_framework
:tag: Beginner
:large:
Learn the basics of the JavaScript framework of Odoo. This tutorial will teach you how to work
with Owl components and introduce the basic principles underlying the Odoo JavaScript
codebase.
This tutorial will teach the basics of the web framework and how to work with Owl components
by customizing the web client.
.. card:: Master the Odoo Web Framework
.. card:: Master the web framework
:target: tutorials/master_odoo_web_framework
:tag: Advanced
Become an expert in the Odoo Web Framework. A large variety of features are covered such as
fields, views, and even the kitten mode.
Become an expert in the web framework. A large variety of features are covered such as fields,
views, and even the kitten mode.
Expand your knowledge on the server framework
=============================================
.. cards::
.. card:: Define module data
:target: tutorials/define_module_data