Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

DOC: new user guide structure #366

Merged
merged 3 commits into from
Jan 20, 2025
Merged

Conversation

nghi-truyen
Copy link
Member

New structure to complete for user guide.

@nghi-truyen nghi-truyen added the documentation Improvements or additions to documentation label Jan 17, 2025
@nghi-truyen nghi-truyen added this to the Release v1.1.0 milestone Jan 17, 2025
@nghi-truyen nghi-truyen requested review from pag13 and asjeb January 17, 2025 15:11
@asjeb
Copy link
Collaborator

asjeb commented Jan 17, 2025

@nghi-truyen Tu vois comment le delta entre in_depth/input_data_convention.rst in_depth vs quickstart/input_data_model_initialization.rst ? J'aurais tendance à présenter toutes les options de données dans un même fichier input_data.rst dans le quickstart.

@@ -1,11 +1,11 @@
.. _user_guide.others.input_data_convention:
.. _user_guide.in_depth.input_data_convention:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. _user_guide.in_depth.input_data_convention:
.. _user_guide.quickstart.input_data_convention:

A mettre dans le quickstart ?

.. toctree::
:maxdepth: 1

in_depth/input_data_convention
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
in_depth/input_data_convention

quickstart/cance_first_simulation
quickstart/france_large_domain_simulation
quickstart/lez_split_sample_test
quickstart/input_data_model_initialization
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
quickstart/input_data_model_initialization
quickstart/input_data_convention
quickstart/model_initialization

@@ -0,0 +1,8 @@
.. _user_guide.quickstart.input_data_model_initialization:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. _user_guide.quickstart.input_data_model_initialization:
.. _user_guide.quickstart.model_initialization:

.. _user_guide.quickstart.input_data_model_initialization:

===================================
Input Data and Model Initialization
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Input Data and Model Initialization
Model Initialization

Copy link
Collaborator

@asjeb asjeb Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renommer le doc en model_initialization.rst ?

@asjeb asjeb self-requested a review January 17, 2025 17:17
@nghi-truyen
Copy link
Member Author

nghi-truyen commented Jan 17, 2025

@nghi-truyen Tu vois comment le delta entre in_depth/input_data_convention.rst in_depth vs quickstart/input_data_model_initialization.rst ? J'aurais tendance à présenter toutes les options de données dans un même fichier input_data.rst dans le quickstart.

Oui oui, t'as bien raison, cette partie n'est pas vraiment à sa place dans la section in-depth (j'avais hésité à la mettre ici). Pourtant, je suis pas trop partant de la mettre dans quickstart, vu que cette section est dédiée aux new users (normalement ceux qui n'ont pas besoin d'apprendre comment traiter avec les autres données, vu qu'ils ont déjà les demo data). T'en penses quoi si on la mettait dans classical uses en changeant le titre pour un truc du style : "Using User-Provided Data" ?

@asjeb
Copy link
Collaborator

asjeb commented Jan 20, 2025

Oui ça me va

@nghi-truyen nghi-truyen merged commit 9300e53 into main Jan 20, 2025
22 checks passed
@nghi-truyen nghi-truyen deleted the doc-initialize-user-guide-structure branch January 20, 2025 10:57
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants