open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

Home Page:https://opensauced.pizza/learn

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feature: I'd like to add to the intro course

Lymah123 opened this issue Β· comments

Type of feature

πŸ“ Documentation

Current behavior

Not a problem . Just introduction of additional topics.

Suggested solution

Contributing to Documentation:

-Writing Clear and Accessible Documentation.

-Using Markup Languages (e.g., Markdown, reStructuredText).

-Versioning Documentation.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Good idea @Lymah123. Documentation is often not talked about enough in open source. What do you think @BekahHW?

I wonder how this would fit into the current course structure. Right now, we're looking at a general overview. This is more of an exploration of different types of contribution.

Maybe we start a new section after the Secret Sauce section? We could call it something like "Types of Contributions," and then there would be a section on Documentation, Code, Triaging. @CBID2 what do you think?

Yeah I like the idea @BekahHW. We can further organize this into subsections

Non-coding

  • Documentation
  • graphic design
  • blog writing
    -Examples of contributions that exemplify each style

Coding contributions

  • Fixing bugs
  • making code more accessible
  • Adding features
  • Examples of contributions that exemplify each style

Alright. Thanks for putting my ideas into consideration @BekahHW and @CBID2 .

I appreciate it.

One more question, can I start my research and writing on the subsection? I will give @BekahHW and @CBID2 for review on each section. Let me know your take on that.

Sure @Lymah123! 😊 For the examples, I suggest looking through the Highlights section to find them! 😊

Alright. Thank you.