Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md in docTemplates #409

Open
jordanjones243 opened this issue Jun 28, 2023 · 0 comments
Open

Update README.md in docTemplates #409

jordanjones243 opened this issue Jun 28, 2023 · 0 comments

Comments

@jordanjones243
Copy link
Contributor

jordanjones243 commented Jun 28, 2023

General Support Request

I would like to have the README.md file under docTemplates to be updated to have the readMeAddInfo (README additional info) appear after the use cases of the components, like ti appears in the template of the file. This will allow us to make the README file more readable and present info in a way that makes sense when we have additional info to add.

Possible Solution

Move the readmeAddlInfo auto generated content to below where the useCases content gets generated.

Additional context

Screen Shot 2023-06-28 at 2 45 26 PM

The image shows how the layout of the file is supposed to look at the top, while the additional info is located in the wrong place.

@jordanjones243 jordanjones243 added Type: Feature New Feature not-reviewed Issue has not been reviewed by Auro team members wc-generator labels Jun 28, 2023
@jason-capsule42 jason-capsule42 removed Type: Feature New Feature not-reviewed Issue has not been reviewed by Auro team members labels Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants