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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add a button in the UI to access documentation page #404
feat: add a button in the UI to access documentation page #404
Conversation
@@ -111,6 +111,15 @@ const NavBar = () => { | |||
</li> | |||
</ul> | |||
</div> | |||
<button id="docs" className="btn btn-sm btn-secondary border-0 me-1"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is id
attribute necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not necessary, but it's good practice to keep it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is it a good practice? I think I've never heard of that. What are the advantages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although the button text in our code indicates its purpose for documentation, the 'id' attribute can also serve as a form of documentation. It's beneficial for SEO as well, even though we are not currently focusing on that aspect in our case.
I don't see any issues with it, but I'll remove it if you want :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH I tried to find something on the web that confirms ids affect SEO, but without much luck - if you have any source on that I'll be happy to have a look.
PS I'm genuinely curious about your motives here and not trying to push anything, so there is no need to remove this id
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These points were discussed in a course (Full-Stack Web Development with React Specialization) offered by Hong Kong University on Coursera. TBH, I didn't cross-verify them as SEO wasn't my primary focus. I didn't place significant emphasis on it and simply included the 'id' attribute based on the information from that course. (considering it as a good practice)馃槂
馃摎 Documentation preview 馃摎: https://bowtie-json-schema--404.org.readthedocs.build/en/404/