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

Add README.md file to every new solution to explain how to run it. #17812

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

maliming
Copy link
Member

@maliming maliming commented Oct 6, 2023

Resolves #17807

@maliming maliming added this to the 7.4-patch milestone Oct 6, 2023
@maliming maliming marked this pull request as ready for review October 7, 2023 10:47
Copy link
Member

@EngincanV EngincanV left a comment

Choose a reason for hiding this comment

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

I have three small suggestions that you may wanna consider:

  • It's not too important but there is a standardization problem on the headers in the documentation. For example, one of the headers is like About This Solution, and the other one is like Preparings for the first run. We should select, one of these naming conventions and stick through the documentation. (I think the second one is better but it's up to you.)
  • I think Before running the application might be a better header naming than Preparings for the first run.
  • As mentioned here, we may add a link of the currently selected theme (basic or leptonx-lite), under the Additional resources section.

@hikalkan hikalkan requested review from yekalkan and removed request for hikalkan October 12, 2023 14:15
@yekalkan yekalkan merged commit ac67546 into rel-7.4 Oct 16, 2023
2 checks passed
@yekalkan yekalkan deleted the README.md branch October 16, 2023 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants