Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Reorganize the "Tools to be Successful" chapter to make it flow #240

Open
adiati98 opened this issue Sep 27, 2024 · 2 comments
Open
Labels
documentation Improvements or additions to documentation 👀 needs triage

Comments

@adiati98
Copy link
Member

Description

In the "Tools to be Successful" chapter, we have this structure of sections:

- GitHub & Git
   - Introduction to Git
   - Introduction to GitHub
   - Getting Started with Git and GitHub
- VS Code

The "Getting Started with Git and GitHub" section starts with:

To get started with Git and GitHub, follow these steps:

There are instructions to setup Git, but no instruction to sign-up for GitHub.

This section has a subsection of "Practicing Contributing with VS Code" which content a tutorial to create and clone a repo, make changes, and push them to GitHub.

However, the section "VS Code" is right after this subsection. So, it doesn't make sense to practice on VS Code before explaining it.

Suggested Solution

  • Add an instruction to sign up for GitHub in the "Getting Started with Git and GitHub" section.
  • Move the "Practicing Contributing with VS Code" subsection right after "VS Code" section and make it the same heading level as "Getting Started with Git and GitHub" and "VS Code".
@adiati98 adiati98 added documentation Improvements or additions to documentation 👀 needs triage labels Sep 27, 2024
@adiati98
Copy link
Member Author

@BekahHW I need your thought on this, also, if we want the docs team to work on it or open it for external contributors. Thanks.

@rishita-badole
Copy link

I would also suggest including in the documentation that while creating a new repository is recommended for open source contributions, forking the repository can remain an option as well. This approach offers flexibility for contributors and encourages collaboration. I fully support your idea of opening up the project to external contributors.

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

No branches or pull requests

2 participants