Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Docs: Remove "Using Markdown for This Project" section in Contributing Guide #24

Open
adiati98 opened this issue Dec 28, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation 👀 needs-triage

Comments

@adiati98
Copy link
Member

adiati98 commented Dec 28, 2023

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.
@adiati98 adiati98 added the documentation Improvements or additions to documentation label Dec 28, 2023
@adiati98
Copy link
Member Author

@BekahHW do you have any thoughts on this?

@BekahHW
Copy link
Member

BekahHW commented Jan 20, 2024

Yep.

If we make this part of a monorepo for the courses we'll drop some
Other stuff and have to move some things around. Just something to keep in mind.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation 👀 needs-triage
Projects
None yet
Development

No branches or pull requests

2 participants