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

Update Onboarding Documentation #38

Open
VladimirKupryukhin opened this issue Jun 15, 2024 · 0 comments
Open

Update Onboarding Documentation #38

VladimirKupryukhin opened this issue Jun 15, 2024 · 0 comments
Labels
Documentation Improvements or additions to documentation Good First Issue Something to tackle as a new member

Comments

@VladimirKupryukhin
Copy link
Contributor

Context

We use the geting_started.md file to help new members learn about the software team. But at this point in time, some of the details are outdated.

What to Do

Pretend you are a new member, and follow the instructions to the letter to find inconsistencies.

Here are some known issues

  • At the button of the getting_started.md document, there is no link to the installing_on_mac.md document.
  • The name of the plugins/extensions in VSCode have changed their name as well as the names of the commands you run in the command pallet. This confused a lot of new members.
  • The code_overview.md is outdated. The updated files are in the Discord channel #software-quick-reference
@VladimirKupryukhin VladimirKupryukhin added Good First Issue Something to tackle as a new member Documentation Improvements or additions to documentation labels Jun 15, 2024
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 Good First Issue Something to tackle as a new member
Projects
None yet
Development

No branches or pull requests

1 participant