We need to make sure that README.md fully shows all supported features and correctly reflects the code, factually correct and so on.
For example biggest missing sections are all the same examples, but not for numbered references to links, we need also show examples on how to use named references to links.
Nothing should be deleted (yet may be corrected if not accurate), but new sections for all the support features in codebase should be added. So everything we have in code is described in detail, we might also need ./docs/HOW-IT-WORKS.md, ./docs/REQUIREMENTS.md (collected based on all issues and comments to pull requests), ./docs/ARCHITECTURE.md (to describe in detail dependencies, components and so on), with even deeper details in ./docs/HOW-IT-WORKS.md.
We need to collect data related about the issue to this repository, make sure we compile that data to ./docs/case-studies/issue-{id} folder, and use it to do deep case study analysis (also make sure to search online for additional facts and data), list of each and all requirements from the issue, and propose possible solutions and solution plans for each requirement (we should also check known existing components/libraries, that solve similar problem or can help in solutions).
Please plan and execute everything in a single pull request, you have unlimited time and context, as context auto-compacts and you can continue indefinitely, until it is each and every requirement fully addressed, and everything is totally done.
We need to make sure that README.md fully shows all supported features and correctly reflects the code, factually correct and so on.
For example biggest missing sections are all the same examples, but not for numbered references to links, we need also show examples on how to use named references to links.
Nothing should be deleted (yet may be corrected if not accurate), but new sections for all the support features in codebase should be added. So everything we have in code is described in detail, we might also need ./docs/HOW-IT-WORKS.md, ./docs/REQUIREMENTS.md (collected based on all issues and comments to pull requests), ./docs/ARCHITECTURE.md (to describe in detail dependencies, components and so on), with even deeper details in ./docs/HOW-IT-WORKS.md.
We need to collect data related about the issue to this repository, make sure we compile that data to
./docs/case-studies/issue-{id}folder, and use it to do deep case study analysis (also make sure to search online for additional facts and data), list of each and all requirements from the issue, and propose possible solutions and solution plans for each requirement (we should also check known existing components/libraries, that solve similar problem or can help in solutions).Please plan and execute everything in a single pull request, you have unlimited time and context, as context auto-compacts and you can continue indefinitely, until it is each and every requirement fully addressed, and everything is totally done.