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

Corrected headings level and anchor syntax #211

Merged
merged 2 commits into from
Mar 24, 2023

Conversation

pbuehler
Copy link
Collaborator

This streamlines the presentation of the "data model reference".

@pbuehler
Copy link
Collaborator Author

@vkucera There are still problems with the internal links. To replace "<h2 id=" by "<a name=" is obviously not sufficient to solve the issue. However, with this PR the headings levels should be improved. The modified python scripts, which produce the new layout will be provided in an extra PR to the O2 repo.

@vkucera
Copy link
Contributor

vkucera commented Feb 24, 2023

@vkucera There are still problems with the internal links. To replace "<h2 id=" by "<a name=" is obviously not sufficient to solve the issue. However, with this PR the headings levels should be improved. The modified python scripts, which produce the new layout will be provided in an extra PR to the O2 repo.

Thanks, @pbuehler . Concerning the heading levels, I am thinking whether the workflow names should be at the third level everywhere to avoid blowing up the menu with the long list. See my comment AliceO2Group/AliceO2#10823 (comment)
For the internal links, I guess it's a limitation of markdown-link-check that we have to live with.

@pbuehler
Copy link
Collaborator Author

This concerns the helper tasks only, right? With he current number of tasks I think it is ok to have them listed in the menu.
Since the list in the menu fits onto one screen, it makes it easy to find and select a specific task and with this helps navigation. Should the number of tasks increase significantly in future we can revisit the situation.

@vkucera
Copy link
Contributor

vkucera commented Feb 24, 2023

If the list fits on the screen, I am fine with it.

@ddobrigk ddobrigk merged commit 3029ceb into AliceO2Group:master Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants