/docs

Codecademy Docs is a collection of information for all things code. ๐Ÿ“•

Primary LanguageTypeScript

Codecademy Docs ๐Ÿ“•

Documentation for popular programming languages and frameworks.
Built by the community. Maintained by Codecademy.

What is Docs?

Codecademy Docs is intended to be a free, easily accessible reference for coding terms and concepts available to learners all over the world. If you forget what JavaScript hoisting is, we want you to be able to look up "JS hoisting" on any search engine, click a Codecademy Doc entry, and have an answer in seconds.

What stage of development are we in right now?

Right now we're trying to create 500 high-quality entries as quickly as we can. We have an engineering team working on creating the Docs website in June-July, after which we'll release an MVP to the world! Once we've released this MVP, our goal is to transition some ownership of Docs content to the Codecademy community, since maintaining a resource of this type at-scale is only possible if it's open-source.

What do I need to do before contributing?

Before contributing, please read through the files in /documentation. There you'll find a write-up of our standards for content and style, as well as templates for creating your entries. Next, check out what entries need to be created in the assignment sheet and put your name next to one.

How do I contribute?

Contributing is as simple as:

  1. Forking this repo.
  2. Editing your fork.
    • Be sure to fetch the main branch shortly before you make your editsโ€”this repo is constantly changing, and trying to merge too old of a fork can be a challenge!
  3. Making a pull request to merge your fork with this repo.

If you haven't gone through this workflow before, you can check out this YouTube video to learn about how to make a pull request from a fork using Git. Alternatively, if you'd prefer to keep things to the GitHub UI for now, you can follow the instructions in that video up to 1:18 to fork this repo. After that, you can create your entry in your fork using the UI and then make a pull request by pressing this handy button:

Code block with Codebyte tags

If you are uncomfortable using Git, you can also check out this YouTube video to do this all using the GitHub Desktop app.

Additional Notes

  • Remember, if you ever have any questions at all, we're there to help in #codecademy-docs-content. Report bugs: #codecademy-docs.