docs: rewrite README with structured sections for users, developers, and adopters#17
Merged
Merged
Conversation
Co-authored-by: hechth <12066490+hechth@users.noreply.github.com> Agent-Logs-Url: https://github.com/RECETOX/specdatri_reporting/sessions/51c3fa1e-a7c7-4863-a7dd-060f2ab4dc48
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
hechth
approved these changes
Mar 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
.env), full CLI reference for all three subcommands (add-repo,collect-stats,generate-reports) with options tables, and an end-to-end manual workflow exampleact-based local GitHub Actions testing (preserves all original caveats)repository_list.tsvcolumn referencesrc/data_sources/)src/reports/)repository_list.tsv, setRECEBOT_REPORTING_TOKEN/pepy_x_api_keysecrets, adjust cron schedule, strip RECETOX-specific content, enable branch protectionOriginal prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.