search

typetools / checker-framework

Pluggable type-checking for Java
http://checkerframework.org/
Other
1.03k stars 356 forks source link

New UI for the website for better readability #6873

Open Neelanchal17 opened 1 month ago

Neelanchal17 commented 1 month ago

I am a web developer and would like to work on improving the website that contains the user manual. I believe it could benefit from a better UI for enhanced readability. I wanted to reach out to the website's maintainers to request their permission to begin working on this. I can submit the updated version within a week and make a pull request as soon as possible. Thank You

mernst commented 1 month ago

We welcome contributions, and we know the website is pretty basic (but functional). Can you be specific about what changes you plan?

Neelanchal17 commented 1 month ago

I believe I can improve the UI elements, such as introducing a more visually appealing navigation bar, adjusting the text font to the right size, introduce a consistent design language, and modernizing the overall user experience. This not only makes the interface more attractive but also improves readability for users going through the manual. With your approval, I can begin working on the code.

mernst commented 1 month ago

Can you be more specific? What navigation bar will you replace with a "more visually appealing" one? What text font is the wrong size, and what is "the right size"? Where is the design language inconsistent, and what would the consistent design language look like? What does "modernizing" mean? What webpages do you have in mind? Are you thinking only of improving the one file https://checkerframework.org/manual/index.html, or other parts of the Checker Framework website?

Thanks.

Neelanchal17 commented 1 month ago

Okay to visualize what I meant, I'll create a repo and show you, just give me a 1-2 days. Thankyou

Neelanchal17 commented 1 month ago

Here's the repo, you can open the Checker Framework.html file with live server to take a look, the website isn't completely changed, I just wanted to put out an example of what I want to do. Further I want to improve the navigation of the manual by introducing a side bar. With your permission I will start working on it. You can even create a repo on your projects so that I can make PRs. Thank You PS: Sorry for the incomplete redesign, I will surely PR a better version next time. https://github.com/Neelanchal17/checker_framework

Neelanchal17 commented 3 weeks ago

Should I continue working on this and update the repo, or should I draft this project? Still waiting for your response. Thank You

mernst commented 3 weeks ago

Sorry for the delay. I was traveling, but I am back now. I will look in the next few days. Thank you!

Neelanchal17 commented 3 weeks ago

It's okay, please feel free to take your time. I appreciate the update. Thank You once again!