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
closesodoo/documentation#8711
X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
In particular, the following changes are made:
- Use the `class` and `attribute` admonitions along with custom
attributes to define classes, views' root attributes, views'
components, and attribute values. This allows re-using the responsive
design that was made for reference lists, and getting rid of the
previous implementation that relied on class attributes, which were not
intended for this usage and reduce readability while hindering further
contributions due to a lack of flexibility (no admonitions,
sub-attributes...)
- Use definition lists to define view types to allow for clearer and
longer descriptions.
- Rewrite and restructure the explanations when there is a lack clarity.
- Extract duplicated content to included RST files.
- Display SVG images into dedicated admonitions.
- Fix RST and English mistakes.
- Rename `view_architecture` to `view_architectures`, as it lists all
existing architectures and doesn't describe "the architecture of a
view".
- Replace underscores with hyphens in image file names to improve SEO.
task-3458320
closesodoo/documentation#5237closesodoo/documentation#7497
X-original-commit: a17eaf4c6f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The documentation of the views is redone in order to be up to date and
has allowed a better visualization of the task on the modifiers.
task-2495504
closesodoo/documentation#3523
Related: odoo/odoo#104741
Related: odoo/enterprise#35255
Related: odoo/upgrade#4884
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
