Skip to content

[WIP] Update README to follow HERO pattern and document helpers#51

Merged
mathieumack merged 2 commits intomainfrom
copilot/update-readme-hero-pattern
Feb 8, 2026
Merged

[WIP] Update README to follow HERO pattern and document helpers#51
mathieumack merged 2 commits intomainfrom
copilot/update-readme-hero-pattern

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 8, 2026

Thanks for assigning this issue to me. I'm starting to work on it and will keep this PR's description up to date as I form a plan and make progress.

Original prompt

This section details on the original issue you should resolve

<issue_title>Update README to follow HERO pattern and document helper implementation</issue_title>
<issue_description>Update the solution's README file to improve the global documentation by following the HERO pattern. For each project in the solution:

  • Add clear sections in the README that correspond to the HERO model (Highlight, Explain, Resources, Operation).
  • Document how to implement and use the helpers provided by each project.
  • Include detailed steps/examples for integrating helpers into other projects within the solution.

This effort will improve the onboarding process for new contributors and provide better guidance on leveraging the provided helpers.</issue_description>

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: mathieumack <12582537+mathieumack@users.noreply.github.com>
@mathieumack mathieumack marked this pull request as ready for review February 8, 2026 20:33
Copy link
Copy Markdown
Owner

@mathieumack mathieumack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better than previous version ;)

@mathieumack mathieumack added the documentation Improvements or additions to documentation label Feb 8, 2026
@mathieumack mathieumack merged commit 84c6f70 into main Feb 8, 2026
5 checks passed
@mathieumack mathieumack deleted the copilot/update-readme-hero-pattern branch February 18, 2026 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README to follow HERO pattern and document helper implementation

2 participants