Giter Club home page Giter Club logo

docs's Introduction

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?

Docs is live with about 590 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-source. That means we need your help, whether it's contributing, reviewing, or evangelizing!

Core Team

TBD

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

What do I need to do before contributing?

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

How do I contribute?

Thanks for your interest; we'd love to work with you! πŸ’– Contributing follows this flow:

  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 here to help!

docs's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.