Separate Markdown Style Guidelines from General Guidelines #51
Labels
documentation
This issue or pull request improves or adds to documentation
improvement
This issue or pull request will add or improve functionality, maintainability, or ease of use
💡 Summary
Break out all of the Markdown specific guidelines in
style-guide.md
into an appropriatelanguages/markdown
section.Motivation and context
Currently the information in
style-guide.md
contains plain language guidelines intermixed with Markdown specific guidelines. I believe it would be better served to break out any Markdown specific guidelines into it's own language section. This will make it more obvious where to find the information as well as improving maintainability.Implementation notes
The PR should be limited to creating a new
languages/markdown
section and only moving existing Markdown content instyle-guide.md
to this section. Any additions/modifications to the Markdown guidelines should be kept to their own PRs after this separation.Acceptance criteria
The text was updated successfully, but these errors were encountered: