Docs: Remove "Using Markdown for This Project" section in Contributing Guide #24
Description
Background
The "Using Markdown for This Project" section contains the Markdown convention we use at OpenSauced.
The first paragraph in the section mentioned that we have a style guide that located in the pizza-verse repository. However, this section is more comprehensive than the style guide.
Currently, we only have this section in the "Intro to OSS course" and "Maintainer Intro Course" repos. But there is a potential that we will refer this section to contributors who work on docs across repos.
We might want to consider having this in one place — the "Introduction to Contributing" section in the Docs might be suitable for it — and link it to all docs-related repos. That way, we can also minimize the length of the Contributing Guidelines.
Suggest Solution
-
Move the "Using Markdown for This Project" section to the Contributing Guidelines in OpenSauced Docs.
-
Change the title to "Markdown Style Guide".
-
Adjust the content, if necessary, to be applicable to all repos.
-
Link the Markdown guide from the Docs in the Contributing Guide of this repo with suggestion as below:
## Markdown Style Guide Please follow our [Markdown Style Guide](<link to the docs>) for the Markdown convention that we use at OpenSauced when you contribute to this project.