codecademy / docs

Codecademy Docs is a collection of information for all things code. 📕

📕 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

• @aherman91, Curriculum Developer
• @caupolicandiaz, Content Contributor
• @HishamT, Content Contributor
• @KTom101, Content Contributor
• @sswiniarski, Content Contributor
• @yangc95, Content Contributor

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

🏗 Engineering Team

• @awgraves
• @bndiep
• @christian-dinh
• @codecademy-aditya
• @jrood

How do I contribute?

Here's how you can contribute to Codecademy Docs:

1. Get assigned to an Issue of your interest.
   • Ask to be assigned to one of the available Issues.
   • Submit a typo/bug in GitHub Issues.
2. Write a new entry or make changes to an existing entry, based on the requirement of your Issue.
3. Submit a Pull Request of your entry for your assigned Issue.
4. 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.
5. 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.

docs's Issues

JavaScript entries needed: Iterators, Objects

Update: THIS ONE IS TAKEN!

2 JavaScript entries are needed:

• Iterators
• Objects

Existing Codecademy JavaScript concepts: https://www.codecademy.com/resources/docs/javascript

[Entry Request] Python: Iterators

Description

Write an "Iterators" entry in the Python topic.

General topic: https://www.codecademy.com/resources/docs/python

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

Python entry needed: Sets

1 Python entry needed:

• Sets

Python entry: PIP

Python enty needed:

• PIP

[Entry Request] What is an Object?

Description

Create a "What is an Object?" entry in the General section.

General section: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

General entry: What is GraphQL?

I am making a general entry about GraphQL. This issue is open to anyone who wants to contribute.

Here is a blueprint I have made:

• A brief history of GraphQL
• What is GraphQL?
• Why use GraphQL?
• How GraphQL works under the hood?
• Who is using GraphQL?

General entry: What is Cloud Computing?

Requesting 1 new entry in the General topic:

• Name: "What is Cloud Computing?"
• Folder: https://github.com/Codecademy/docs/tree/main/content/general/concepts

3 Semantic HTML entries needed

3 semantic html tags:

• <section>
• <mark>
• <time>

Scroll down here: https://www.codecademy.com/resources/docs/html/semantic-html

Next.js description is inaccurate

Typical React apps use the client-side browser to upload content, Next.js is unique in that it is a React framework built on top of Node.js. This helps curtail certain issues such as a user not having access to JavaScript. This also enables Next.js to render content on the server-side before it can be viewed by the client.

• Most popular React frameworks can SSR (Server Side Render) and are built on Node.js
• What is "certain" doing in the sentence? (odd grammar choice)

Bug: Path separator is different for mac and windows

Description: In the Codecademy Docs Content - adheres to content file structure test the split doesn't correctly split for Window users. On Mac the / is the separator whereas on windows its \\. So when running the tests on windows the test fails and doesn't split up 'nodePath' variable correctly.

Affected file: https://github.com/Codecademy/docs/blob/main/content.test.ts

Expected: line 53: const nodeName = nodePath.split('/').slice(-1)[0]; to be 'c'

Actual: line 53: const nodeName = nodePath.split('/').slice(-1)[0]; is 'C:\\Users\\USERNAME\\Documents\\codecademydocs\\content\\c'

Suggested change: instead of splitting using /, use path.sep (see https://nodejs.org/api/path.html#path_path_sep)

For example line 53 becomes:
const nodeName = nodePath.split(path.sep).slice(-1)[0]; this will fixfor windows or mac users when running test locally

@sonnynomnom

JavaScript entries needed: Modules, Requests

2 JavaScript entries are needed:

• Modules
• Requests

Existing Codecademy Docs JavaScript entries: https://www.codecademy.com/resources/docs/javascript

Java entry needed: Functions

One Java entry needed:

Functions

C++ entry needed: Files

One C++ entry needed:

• FIles

[Entry Request] What is UUID?

Description

Write a "What is UUID?" (universally unique identifier) entry in the General topic.

General topic: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

C entry needed: Memory Management

1 C entry needed:

• Memory Management in C

Python entry needed: Files

One new Python entry about the topic Files.

SQL entry needed: Procedures

1 SQL entry needed:

• Procedures

Suggestion: Add husky to catch test failures and lint errors locally

Husky is a package that can run git hooks before committing to a repository. This package could also be used to lint commit messages and run other bits of code as well.

Recently there have been a few issues with passing the lint and formating tests. The errors only show after the commit has been pushed and ran on Circle CI. Maybe it would be helpful to run tests, formatter, and lint just as contributors commit?

This can be version controlled because when a contributor runs yarn install this husky is initiated. Husky is used on a number of other open-source projects and I think Codecademy docs could benefit from also including it.

TLDR; Husky will catch errors locally before being run on Circle CI.

@sonnynomnom What do you think?

[Entry Request] Python: Casting

Description

Write a "Casting" entry in the Python topic.

General topic: https://www.codecademy.com/resources/docs/python

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

C entry needed: User Input

1 C entry needed:

• User Input

Codecademy Docs C Concepts: https://www.codecademy.com/resources/docs/c
Inspiration: https://www.codecademy.com/resources/docs/cpp/user-input

General Entry: What is a Content Management System?

Requesting 1 new entry in the General topic:

Name: "What is a Content Management System?"
Folder: https://github.com/Codecademy/docs/tree/main/content/general/concepts

[Entry Request] Python: Dates

Description

Write a "Dates" entry in the Python topic.

General topic: https://www.codecademy.com/resources/docs/python

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

Feature Request: Page section URLs and table of contents

• Add support for URL suffixes to link directly to page sections. For example, https://en.wikipedia.org/wiki/Instant-runoff_voting#Global_use links to the "Global use" section. Makes it easier for users to access related subtopics from other entries.
• Automatically generate a table of contents for each entry that contains a list of all H2 headers, possibly below the introduction section. Allows users to quickly find the content they're looking for.

[EDIT]: just realized that the actual code for Docs isn't contained in this repo. I'll submit this suggestion to the Google Forms page.

`what-is-git.md` description is too long

The description for the "What is Git?" entry inside of content/general/content/what-is-git/, is too long and needs to be shortened.

Per the terms-entry-template.md:

Description: 'A brief description' # Required; ideally under 150 characters (used in search engine results and content previews)

The character count of the description for "What is Git?" is currently 522 characters.

[Entry Request] Python: Scope

Description

Write a high-quality "Scope" entry in the Python topic.

General topic: https://www.codecademy.com/resources/docs/python

Please read through the README file and Contribution Guide.

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

Semantic HTML entries needed: <details>, <summary>

Semantic HTML still lacking the following term entries:

• <details>
• <summary>

Docs page: https://www.codecademy.com/resources/docs/html/semantic-html
GitHub folder: https://github.com/Codecademy/docs/tree/main/content/html/concepts/semantic-html

Java entry needed: HashMap

Java entry needed:

• HashMap

General entry: What is an NFT?

Requesting 1 new entry in the General topic:

• Name: "What is an NFT?"
• Length: 500-100 words
• Folder: https://github.com/Codecademy/docs/tree/main/content/general/concepts

Python String methods needed: .find() and .format()

Note: Before creating a new issue, please ensure that a similar issue hasn't already been posted in the "Issues" tab.

Description

Python string methods:

• .find()
• .format()

They will live here: https://www.codecademy.com/resources/docs/python/strings (Scroll down)

Type of Issue(s)

• One or more new entries/terms requested.
• Typo and/or bug within one or more existing entries.
• Unclear definition/explanation of term(s).
• Out-of-date information (new release, deprecated package, etc.).
• Recommend change(s) to documentation (such as existing text or new text)

Type of Recommended Change(s)

• Adding between one and three new entries (max 3 per pull request)
• Editing one or more existing entries (fixing a typo, bug, issues, etc)
• Updating the documentation

Checklist

• A similar issue hasn't already been created.
• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.

Python entry needed: Decorators

Python entry needed for the following concept:

• Decorators

More Swift entries: Tuples, Protocols, Classes

3 more Swift entries needed:

• Tuples
• Protocols
• Classes

Swift entries needed: Enums, Optionals

2 entries are needed for Swift:

• Enums
• Optionals

Codecademy Docs: https://www.codecademy.com/resources/docs/swift
GitHub folder: https://github.com/Codecademy/docs/tree/main/content/swift/concepts

[Entry Request] What is Subroutine?

Description

Write a "What is Subroutine?" entry in the General topic.

General topic: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

R entries needed

We currently don't have any R entries. Feel free to create a folder structure and 2-3 entries!

C entry needed: Compiling

1 C entry needed:

• Compiling

Codecademy Doc C topic: https://www.codecademy.com/resources/docs/c

Java entry needed: ArrayList

1 Java entry needed:

• ArrayList

[Entry Request] Python: Inheritance

Description

Write an "Inheritance" entry in the Python topic.

General topic: https://www.codecademy.com/resources/docs/python

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

C entry needed: Preprocessors

1 C entry needed:

• Preprocessors in C

[Entry Request] General: Routing

Description

Write a "Routing" entry in the General topic.

General topic: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

[Entry Request] General: QR Code

Description

Write a "QR Code" entry in the General topic.

General topic: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

Python entries needed: Modulo, Tuples, Modules

Python entry needed for the following concepts:

• Tuples

Website Down

I am in the middle of a project using Codecademy Docs, and the website has been acting up for a while. At first I thought it was just an issue with the server (because of multiple 404s and 503s), but now I see it has been removed from the Resources tab?

I checked commits and blog posts to see if there was anything about taking it down, but I didn't see anything. Any help would be greatly appreciated!

Python entry: Modules

1 Python entry needed:

• Modules

[Entry Request] What is Server-side Rendering?

Description

Write a "What is Server-side Rendering?" article in the General section if you have an advanced web dev background.

General: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

Fix entry: Turn JavaScript Errors into Multiple Term Entries

[Entry Request] General: Unit Testing

Description

Write a "Unit Testing" entry in the General topic.

General topic: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

[Entry Request] Python: Modulo

Description

Write a "Modulo" entry in the Python topic.

General topic: https://www.codecademy.com/resources/docs/python

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

C++ entry needed: Pointers

1 C++ entry needed:

• Pointers

[Entry Request] What is WebRTC?

Description

Write a "What is WebRTC?" entry in the General section:

General section: https://www.codecademy.com/resources/docs/general

Type of Entry Request

• One or more new entries/terms requested.

Checklist

• The issue is appropriately titled.
• Description is clear and includes supporting text, files, etc.
• A similar issue hasn't already been created.
• No more than 3 entries requested.

For Maintainers

• Labels are added
• Assignee is added

React entry needed: Lifecycle Methods

1 React entry needed

• Lifecycle Methods

From a learner:

@Dusch4593?