-
Notifications
You must be signed in to change notification settings - Fork 0
Attractive project readme file #28
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
base: main
Are you sure you want to change the base?
Conversation
More information and about sub-libraries and maintainers has been added into the readme file. It also, somehow enhanced to be more readable and categrized. Signed-off-by: Hadi Adineh <122263902+hadi-adineh-ascs@users.noreply.github.com> Signed-off-by: Hadi Adineh <hadi.adineh@asc-s.de>
Signed-off-by: Hadi Adineh <hadi.adineh@asc-s.de>
Signed-off-by: Hadi Adineh <hadi.adineh@asc-s.de>
e51088e to
0980b78
Compare
|
@ClemensLinnhoff do you know why the linter is complaining even if the links are clickable? |
Signed-off-by: ClemensLinnhoff <Clemens.Linnhoff@partner.bmw.de>
Signed-off-by: ClemensLinnhoff <Clemens.Linnhoff@partner.bmw.de>
Signed-off-by: ClemensLinnhoff <Clemens.Linnhoff@partner.bmw.de>
The linter seems to be confused, because the heading is also a link. It does not fail at the link to I guess this is not really a proper heading style. I originally thought the reason is, that the heading is also part of a list (which I wouldn't do) but I tested it and the linter still fails. There are now three possibilities on how to proceed:
Since linking from the table of contents to the heading works and I think it is kind of intuitive, that the heading directly links to the corresponding repository, I would suggest we choose option 1 and simply ignore the linter warnings. All that aside, I would still not use a list for the headings. Therefore, I left my commit testing this on SL1-0 in the PR. |
|
Furthermore, I would not put the images from the repository in the profile, since it makes it quite long to scroll through. |
Signed-off-by: Hadi Adineh <hadi.adineh@asc-s.de>
|
@ClemensLinnhoff: Due to your review comments, following changes has been done in last commit: |
Signed-off-by: Hadi Adineh <hadi.adineh@asc-s.de>
|
@jdsika and I just created a brand new documentation page for OpenMSL: https://openmsl.github.io/doc/ I think we can integrate some of your improvements intended for the profile there. But we can discuss this in the next maintainer meeting. |
|
I think we can close this PR and the corresponding issue as some of the proposed changes were implemented in the documentation instead of the profile. |
Reference to a related issue in the repository
#27
Add a description
Making the project reamde file more attractive in promotions.
Some questions to ask
What is this change? improving the project readme file.
What does it fix? the content and structure of the project readme file.
Is this a bugfix or a feature? Just enhancement of the readme file
Does it break any existing functionality or force me to update to a new version? no
How has it been tested? by markdownlint
Take this checklist as orientation for yourself, if this PR is ready for Maintainer Review
If you are still working on this PR, submit as "Draft Pull Request", which can be selected in the green button at the bottom.
If your work is done, but you can’t check all the boxes above, please explain why.
If all boxes are checked or commented, you can submit as a pull request directly.