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

Documentation of performance and accessibility guide #8057

Open
Tlazypanda opened this issue Jun 22, 2020 · 7 comments
Open

Documentation of performance and accessibility guide #8057

Tlazypanda opened this issue Jun 22, 2020 · 7 comments
Labels
feature explains that the issue is to add a new feature outreachy

Comments

@Tlazypanda
Copy link
Collaborator

Please describe the desired behavior.
Currently all the new changes introduced during Outreachy are not documented making it difficult for future contributors to maintain and improve on performance and accessibility.

Adding a performance and accessibility guide can help solve this problem by providing contributors links to changes made and offer tips on things to keep in mind while opening new pull requests.

@Tlazypanda Tlazypanda added the feature explains that the issue is to add a new feature label Jun 22, 2020
@Tlazypanda
Copy link
Collaborator Author

Hey @jywarren as per our discussion on various issues that some sort of notes is required to keep track of changes maybe we can link this to the readme - https://hackmd.io/@itm2017004/BJuqtap6L initial draft ✌️

@Tlazypanda
Copy link
Collaborator Author

Tlazypanda commented Jun 30, 2020

Hey @jywarren @cesswairimu @ebarry I am almost done with this can you please have a look? Thanks ✌️

@ebarry
Copy link
Member

ebarry commented Jul 2, 2020

Yes, have it open now, will be reading during today! thank you @Tlazypanda for being part of the documentation revolution!

@ebarry
Copy link
Member

ebarry commented Jul 2, 2020

Hi @Tlazypanda , it's so great to read documentation like this. Thank you!
Are any parts of this documentation aimed at non-coders, such as the people using the website directly? I was wondering this because of sections like https://hackmd.io/@itm2017004/BJuqtap6L#Avoiding-suspicious-link-text and the advice to avoid underlining.

@Tlazypanda
Copy link
Collaborator Author

Hey @ebarry I am not sure how links are rendered by the editor now but yes these can be used as general guidelines as well to make posts more accessible 😅 Originally this was meant for developers only but maybe we can extend it ✌️

@Tlazypanda
Copy link
Collaborator Author

Updated docs with some more added points 😅 suggestions and feedback welcome on what else to add ✌️

@stale stale bot added the stale label Oct 7, 2020
@cesswairimu cesswairimu removed the stale label Oct 7, 2020
@cesswairimu
Copy link
Collaborator

Hey @Tlazypanda how are you doing? Did you want to move the documentation to the PL website or maybe make a markdown for it on the repo. Whats do you think? Thanks

@publiclab publiclab deleted a comment from stale bot Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature explains that the issue is to add a new feature outreachy
Projects
None yet
Development

No branches or pull requests

3 participants