Skip to content
This repository has been archived by the owner on Oct 20, 2022. It is now read-only.

Section link anchor icon #283

Open
brandenchan opened this issue Apr 20, 2022 · 2 comments
Open

Section link anchor icon #283

brandenchan opened this issue Apr 20, 2022 · 2 comments
Assignees
Labels
Should Features which should be implemented

Comments

@brandenchan
Copy link
Contributor

  • We used to have anchor links via icons for each section in the docs which made it easier to share the exact position of a page in a link
  • It would be really helpful to have these
  • c.f. This page where a link icon comes up when you hover near a section title
@brandenchan brandenchan added the Should Features which should be implemented label Apr 20, 2022
@fstau
Copy link
Contributor

fstau commented Apr 27, 2022

@brandenchan would you like to have control over which headlines get this anchor or should every headline get this and we just use the text of that headline to generate the link (e.g. "Language Modelling" -> "#language-modeling")?

@brandenchan
Copy link
Contributor Author

In our docs, and tutorials, anything that is a level 1 or 2 headline should get this anchor I reckon (e.g. "# Document Store" or "## Elasticsearch Document Store"). Though one exception to this is the API docs where each class and class method should have an anchor. I believe these might be level 2 and 3 headlines.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Should Features which should be implemented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants