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

[Docs] Fix anchors #4015

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pubiqq
Copy link
Contributor

@pubiqq pubiqq commented Jan 23, 2024

No description provided.

@raajkumars
Copy link
Contributor

Were these anchors broken or are you just changing them to title case?

@pubiqq
Copy link
Contributor Author

pubiqq commented Jan 31, 2024

They are still broken, try clicking on the "Design & API Documentation" link here, for example.
Title/sentence case doesn't affect the functionality of the links, I changed it just to make the link names match the headers.

Copy link
Contributor

@raajkumars raajkumars left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@leticiarossi
Copy link
Contributor

I'm not sure adding an extra - will work either. It'd probably be best to change the & to be and so we have Design and API Documentation and the link can be #design-and-api-documentation

@pubiqq
Copy link
Contributor Author

pubiqq commented May 10, 2024

I'm not sure adding an extra - will work either.

Well, you can compare the current version with the proposed one yourself. You don't think I just added hyphens to random places for no reason, right? 😂

Or I can just replace all the ampersands in the headings with "and", as you wish.

@leticiarossi
Copy link
Contributor

Ah, I only tested internally where we have the docs and there the current link works and the new one doesn't, but on github I see now it's the opposite. Sometimes there are discrepancies like this with github so changing to Design and API Documentation would be the best option then to work on both places!

Side note - of course I didn't think you'd do a change for no reason, but misunderstandings and mistakes can happen from both sides. Let's cultivate a respectful environment here :)

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.

None yet

3 participants