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

[docgen] generated docs should contain anchors for each section #117

Closed
timotheecour opened this issue Oct 15, 2018 · 6 comments
Closed
Labels
good first issue Good for newcomers

Comments

@timotheecour
Copy link
Member

@timotheecour timotheecour changed the title generated docs should contain anchors for each section [docgen] generated docs should contain anchors for each section Oct 15, 2018
@PMunch
Copy link

PMunch commented Oct 17, 2018

Well, it actually does create anchors. If you try to go to e.g: https://nim-lang.github.io/Nim/contributing.html#stdlib it will show you the correct section. However it doesn't generate any way to get these anchors. It appears like there is some part of the documentation generation that inserts a toc. But I don't know what exactly adds it and how.

@timotheecour
Copy link
Member Author

@PMunch I added 2 EDIT's above to clarify

@github-actions
Copy link

This RFC is stale because it has been open for 1095 days with no activity. Contribute a fix or comment on the issue, or it will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jun 12, 2023
@mratsim mratsim added good first issue Good for newcomers and removed Stale labels Jun 12, 2023
@mratsim
Copy link
Collaborator

mratsim commented Jun 12, 2023

This seems like an issue that doesn't require much discussion and with extremely low impact/risk so removing stale label.

@pietroppeter
Copy link

honestly I am not sure there even still is an issue and what would that be, I think it can be safely closed.

If I look at https://nim-lang.github.io/Nim/algorithm.html and scroll down to the first appearance of sorted the keyword sorted is indeed clickable (so I would say the anchor is accessible) and it gets me here: https://nim-lang.github.io/Nim/algorithm.html#sorted%2CopenArray%5BT%5D%2Cproc%28T%2CT%29

Again in https://nim-lang.github.io/Nim/contributing.html#stdlib if I hover over stdlib I do see the url.

I also see a TOC in https://nim-lang.github.io/Nim/contributing.html

@pietroppeter
Copy link

and in case there are still issues, it looks more than an issue for Nim than a RFC (maybe it was not at the time...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants