typetools / typetools/checker-framework

New UI for the website for better readability

Open
#6,873 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
440
Avg merge
1d 12h
Merged PRs (30d)
134

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names only the website containing the user manual; no files, tests, or entry points are provided. First clarify the target pages, UI and readability requirements, and acceptance criteria with maintainers, then verify the updated website against those criteria.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.