-
-
Notifications
You must be signed in to change notification settings - Fork 523
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: add headers and improve copy #410
Comments
@alequetzalli Is this issue still open and will you please describe the issue more like, where are the headers need to be improved? |
Hello @akshatnema! Thank you for your interest in contributing to the Docs 📄 🥳! Yes, it is still open and I guess the reason it is still in "backlog" is that I was trying to first finish #350. As you can see, #350 is pretty involved. 😅 😮💨 Anyways, to answer your last question, I am trying to identify how to improve the written content in the current docs. I think that some pages have spare headers and that is a bad UX for readers, as well bad for us because then we also lose SEO benefits. Does this make sense so far? If so, basically if you wanted to contribute and pick up this issue, I think of the goal as going through EACH doc page and seeing which can be improved and lack useful headers. Let me know if you would like to pick this one up 😀👍🏽👍🏽 |
@alequetzalli I tried to figure out the spare headers in docs, but couldn't able to find them. Will you please send a ss and explain me in which way you want to make them look more good? |
Hey @akshatnema, apologies! I think I used an English word wrong and made it more confusing. 😄 I didn't mean to write "spare headers," I was trying to say that we don't have many headers. That is to say, we could benefit from adding more headers to doc pages that have no headers or not enough. So this is not about coding or design, this is only from a writing perspective. Think about each page and what it attempts to describe to the reader. Then see if the current written content seems to have been outlined clearly with the use of headers. If you get an idea of what headers to add, then go ahead and open a PR to suggest your improvements. 🙂 Let me know if this helps! ❤️✨ |
I am closing this issue because it's too vague and doesn't seem to help the community know how to jump in and improve it. I am instead creating new and better tailered issues that are all available in our GH Docs Board and our Docs slack channels. |
Reason/Context
The text was updated successfully, but these errors were encountered: