🚧Change how README is transformed

[CalvinWilkinson]

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Currently, when a project is doing a release, the release notes are checked to be able to automate the process of refactoring the README before packing the release notes into the NuGet package.

The reason this is done is because the readme file contains HTML that is valid and used in GitHub, but not in nuget.org. This is why the process is ran.

The current refactor process is causing issues with the team members being able to quickly understand and properly deal with the special syntax in the readme that the translator requires. To fix this, the idea is that the translator will not require special markers in the readme to commend and uncomment blocks.

Instead, it will search for each type of GitHub flavor of HTML and/or markdown and then automatically just translate it to the nuget.org flavor of markdown.

This will greatly reduce the maintenance and complexity of the README files.

Acceptance Criteria

• README translator changes working

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct project (if applicable).
• Issue linked to the correct milestone (if applicable).
• Draft pull request created and linked to this issue (only required with code changes).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Change Type Labels

Change Type	Label
Bug Fixes	🐛bug
Breaking Changes	🧨breaking changes
New Feature	✨new feature
CICD Changes	♻️cicd
Code Doc Changes	🗒️documentation/code
Product Doc Changes	📝documentation/product

Priority Type Labels

Priority Type	Label
Low Priority	low priority
Medium Priority	medium priority
High Priority	high priority

Code of Conduct

• I agree to follow this project's Code of Conduct.