Welcome to the Code Thesaurus documentation!
What is Code Thesaurus?
It is a polyglot developer reference tool originally created to help you compare a language you know with one you don't. The main purpose is to be a quick and easy way to help people that use a lot of programming languages and have to context switch between them. It also allows you to pick up how to use a new programming language fast without needing to read documentation.
tl;dr Getting Started
While we recommend reading over the docs for the part of the site you're working on, we realize many like to get started ASAP!
- Pull down the main site repo from GitHub.
- Build the Docker container.
- Run the site.
- The code is linked into the container, so changes take effect immediately upon saving.
- Find one of our dozens of available issues, the vast majority of them looking for help.
Issues almost always have enough context that you don't need to read the docs unless you need more specific information.
If you're newer to open source, grab one of our "Good First Issue" issues.
How do I install and run this repo?
Check out the Installation section to get all the installation directions for the main site as well as the documentation.
How can I help?
This project values open source contributors, both to the main project and to the documentation! We'd love to have your help.
- Start with our Contribution Guidelines
- Look through the repo for issues or bugs
- Add any missing information on the main site
- Correct any incorrect information on the main site or the documentation
- Help think through the future of what Code Thesaurus could be
- Find more developers of any experience level and background to help contribute!