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

feat: reorder chapters #71

Merged
merged 6 commits into from
Apr 23, 2024
Merged

feat: reorder chapters #71

merged 6 commits into from
Apr 23, 2024

Conversation

adiati98
Copy link
Member

@adiati98 adiati98 commented Apr 4, 2024

Description

This PR reorders the chapters on README and sidebar based on this discussion, as well as gives short summaries for each chapter on README.

Related Tickets & Documents

Closes #50

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@adiati98 adiati98 added the documentation Improvements or additions to documentation label Apr 4, 2024
@adiati98 adiati98 self-assigned this Apr 4, 2024
@adiati98 adiati98 requested a review from a team as a code owner April 4, 2024 20:29
@adiati98 adiati98 mentioned this pull request Apr 7, 2024
16 tasks
@@ -14,23 +14,43 @@ The course is divided into chapters, with each covering a different aspect of be

### [Intro: Understanding the Role of an Open Source Maintainer](/intro.md)

This chapter introduces the role of maintainers in open source, the benefits and the responsibilities of becoming a maintainer, and the challenges they face.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to change "chapter" to section or are we ok with it as long as it doesn't refer to a specific number?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we keep "chapter" as is so we can refer to the subsections as "section". And yes, as long as we don't refer them to a specific number.

Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll approve this, and leave the decision in the comment to you, @adiati98

@adiati98 adiati98 merged commit 85d2dcb into main Apr 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Decide on final order for chapters & update README before launch
2 participants