Skip to content

docs: rewrite README with structured sections for users, developers, and adopters#17

Merged
hechth merged 2 commits into
mainfrom
copilot/update-readme-sections
Mar 25, 2026
Merged

docs: rewrite README with structured sections for users, developers, and adopters#17
hechth merged 2 commits into
mainfrom
copilot/update-readme-sections

Conversation

Copilot AI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

The README was a minimal ~47-line developer-only document with no explanation of what the tool does, how the automation works, or how to use/extend it.

Changes

  • Overview — what the tool does, a data-sources table (PyPI/CRAN/Bioconda monthly; GitHub weekly), and a step-by-step breakdown of the GitHub Actions pipeline
  • User Guide — prerequisites, setup (venv → install → .env), full CLI reference for all three subcommands (add-repo, collect-stats, generate-reports) with options tables, and an end-to-end manual workflow example
  • Developer Guide
    • Dev setup with pre-commit hooks
    • Test and coverage commands
    • act-based local GitHub Actions testing (preserves all original caveats)
    • Adding new repositories via CLI + repository_list.tsv column reference
    • Skeleton + steps for integrating a new data source (src/data_sources/)
    • Skeleton + steps for integrating a new report type (src/reports/)
  • Adopting This Framework — six-step guide for external teams: fork, configure repository_list.tsv, set RECEBOT_REPORTING_TOKEN / pepy_x_api_key secrets, adjust cron schedule, strip RECETOX-specific content, enable branch protection
Original prompt

This section details on the original issue you should resolve

<issue_title>update the readme</issue_title>
<issue_description>Update the readme to have main sections explaining first what the repository does, what it is used for and what kind of data is presented. Also a bit the mechanism with the github actions etc. Then include a user section, which describes how the tool can be used manually. Then have a developer section that describes how the testing and development process works, also how the github actions can be tested locally (which is already covered in the current documentation). Also describe how new repositories can be added using the scripts and how new reports or data sources could be integrated. Lastly, add a section for external people who want to copy the same scheme for some of their repositories.</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Copilot AI changed the title [WIP] Update the README with detailed sections docs: rewrite README with structured sections for users, developers, and adopters Mar 25, 2026
Copilot AI requested a review from hechth March 25, 2026 17:32
@hechth hechth marked this pull request as ready for review March 25, 2026 19:26
@hechth hechth merged commit e3a9f51 into main Mar 25, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update the readme

2 participants