[go: up one dir, main page]

Skip to content

Codecademy/docs

Repository files navigation

πŸ“• Docs

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

What is Docs?

Docs is a free, easily accessible reference for coding terms and concepts, available to developers 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 Doc entry, and have an answer in seconds.

What stage of development are we in right now?

Docs is live with over 2000 high-quality entries. Now that the MVP is out, 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-contribution. That means we need your help, whether it's contributing, reviewing, or evangelizing!

πŸ“ Content Team

We are currently building a team of community volunteers and educators to maintain Docs. Let us know if you are interested.

πŸ— Engineering Team

How do I contribute?

Here's how you can contribute to Codecademy Docs:

  • Get assigned to an Issue of your interest:

  • Prepare your contribution:

    • Fork the Codecademy docs repository on your GitHub account.

    • Create a new branch for your contributions:

      git checkout -b branch_name
    • Write a new entry or make changes to an existing entry, based on the requirement of your Issue.

  • Submit your work:

    • Submit a Pull Request of your entry for your assigned Issue.
  • Collaborate and provide feedback:

    • Reply to the thread on Possible Content Discussion to share ideas and collaborate with other contributors, maintainers, or super users to determine good future issues.
    • Share your thoughts in this Docs feedback form to tell us how we can improve Docs!

Whether you are a code newbie or a seasoned hacker, there's something for you!

Please read through the Contributing Guide. There, you'll find a write-up of our content standards and style guide, as well as templates for creating your entries.

Additional Notes

Remember, if you ever have any questions at all, we're always here to help in the Codecademy Forums and Codecademy Discord.