I highly, highly encourage you to read documentation and search through it before you ask someone about a problem. Many of the core problems and examples have been provided in our documentation. In addition, look through our previous projects that have similar tech stacks as your project. We do also provide many outside resources that we think are great for you to use.
Our Documentation Styling
- Whenever there's a
$
in front of blocked code, it means that it's a terminal command. If you open up the terminal, you would see a $
in the very end of the line. This same principle applies to other characters, such as when you access the Postgres Command Line Interface, it would be #
. Here's an example of going into the Postgres CLI and listing all the databases:
$ psql
# \\l
- Our Example Code will generally be styled in Markdown Format. They will not have any special character before them
- If you run into any troubles or confusion, please feel free to contact your PM/TL for assistance.
Online Documentation
- StackOverflow is a common place to look when you're running into an issue, chances are someone else has had the issue too. Being able to find the right answer on stackoverflow is the toughest part, but this will come with time.
- The next place to look is the documentation of the tool, library, or framework you are working with. All of these, as well as built in methods and classes for a language have documentation available online. As a developer, finding and reading documentation should become one of your main skills. You'll never know everything about every tool. As you become more experienced, you should expect to be able to locate what you are looking for in documentation much quicker.