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

Fix linking problem on the documentation table of contents #57

Open
1 of 5 tasks
Cli4d opened this issue Jul 6, 2023 · 3 comments
Open
1 of 5 tasks

Fix linking problem on the documentation table of contents #57

Cli4d opened this issue Jul 6, 2023 · 3 comments
Assignees

Comments

@Cli4d
Copy link
Member

Cli4d commented Jul 6, 2023

Problem Statement

We need t fix the linking problem for the Guidelines Section and the How To Section of the Open Terms Archive documentation so as to make it easier to navigate through different sections of the documentation.

Additional Information

Screenshot of the current linking status
image

What happens if this is not addressed

If not addressed, it may cause some bit of a problem for contributors who want to navigate through sections of the documentation

Recommended Action Items

  • Add a priority label to this issue (OTA team)
  • Add a project label to this issue
  • Discuss with a Community Manager at Open Terms Archive
  • Discuss with the Open Terms Archive team
  • Make a new issue in the project repository

Potential solutions [draft]

We can look at the markdown files and check if they are properly linked and rendered into the documentation website

@Cli4d Cli4d self-assigned this Jul 6, 2023
@Cli4d Cli4d transferred this issue from Cli4d/DPG-OS-CM-Open-Terms-Archive Jul 19, 2023
@MattiSG
Copy link
Member

MattiSG commented Jul 25, 2023

Do you mean that the titles should be clickable? 🤔

@Cli4d
Copy link
Member Author

Cli4d commented Jul 28, 2023

Yeah
That is what I meant. I wasn't sure if they were left unclickable by design or if that was an issue in the docs

@MattiSG
Copy link
Member

MattiSG commented Jul 31, 2023

It is by design: they are titles. But since this is confusing, it should be fixed, probably by changing their appearance.

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

No branches or pull requests

2 participants