Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

The question mark buttons for parameters should link directly to the specific description of each parameter. #280

Open
FredericHirschmueller opened this issue Jan 23, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation frontend

Comments

@FredericHirschmueller
Copy link

Currently, the question mark buttons next to the parameters either link to the exact description of the parameter in ReadTheDocs or redirect to the general overview of all parameters. To ensure consistency, every question mark button must link directly to the description of its respective parameter.

Action required: We need to review all parameters and verify that the links are correctly set.
Example: The button for the parameter "age installed" currently redirects to the general overview instead of the specific description.

@Bachibouzouk
Copy link

The links are normally automatically generated form the csv file

For age install the link is
https://open-plan-documentation.readthedocs.io/en/latest/model/input_parameters.html#age_ins-label

But the real link on RTD is

https://open-plan-documentation.readthedocs.io/en/latest/model/input_parameters.html#age-ins-label

i.e. age_ins-label vs age-ins-label

The reference is defined in the file app/static/MVS_parameters_list.csv

When you hover over a link you can see if it leads nowhere if the link is

https://open-plan-documentation.readthedocs.io/en/latest/model/input_parameters.html#

@Bachibouzouk
Copy link

Bachibouzouk commented Jan 27, 2025

NB: the logic for the help text is located here:

if self.fields[field].help_text is not None:
- @paulapreuss I think I can tackle this faster than you, you can review then :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation frontend
Projects
Status: 🛠 Todo
Development

No branches or pull requests

3 participants