Readme script update #1750
Open
Readme script update #1750
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated the script for to check the README files of the projects based on the new documentation guidlines - Checks for sections, title format, prohibited links, file format & structure within the project's folder. Signed-off-by: Cristian Mihai Popa <[email protected]>
- Renamed to README.md - Contains info about the check_for_missing_readme_md.sh and check_guideline.py - Highlights the guidlines which must be followed when writting a new README file Signed-off-by: Cristian Mihai Popa <[email protected]>
cristianmihaipopa
requested review from
acostina,
AndreiGrozav,
PopPaul2021,
gastmaier and
sarpadi
as code owners
| @@ -1,55 +1,162 @@ | |||
| # User guide for [check_guideline.py](https://github.com/analogdevicesinc/hdl/tree/main/.github/scripts/check_guideline.py) | |||
| # Guidlines & files check scripts | |||
There was a problem hiding this comment.
Suggested change
| # Guidlines & files check scripts | |
| # Guidelines & files check scripts |
Comment on lines
+3
to
+4
| This scripts are used for checking the integrity and correctness of the | ||
| files across HDL/ repository. |
There was a problem hiding this comment.
Suggested change
| This scripts are used for checking the integrity and correctness of the | |
| files across HDL/ repository. | |
| This script is used for checking the integrity and correctness of the README | |
| files across the HDL repository. |
| files across HDL/ repository. | ||
|
|
||
| ## User guide for [check_for_missing_readme_md.sh](https://github.com/analogdevicesinc/hdl/blob/main/.github/scripts/check_for_missing_readme_md.sh) | ||
|
|
|
|
||
| #### 3. Special carrier exceptions | ||
|
|
||
| The following carriers are allowed to use hyphens in their README titles and are not flagged for title mismatches: |
There was a problem hiding this comment.
Suggested change
| The following carriers are allowed to use hyphens in their README titles and are not flagged for title mismatches: | |
| The following carriers are allowed to use underscore in their README titles and are not flagged for title mismatches: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Updated the check_for_missing_readme_md.sh which is responsible to check README files based on the newly implemented documentation guidelines. Also, updated the .md file renaming it to README.md format. In this file are described the two scripts and there're also highlighted the documentation rules regarding README files.
PR Type
PR Checklist