You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to the [Codecademy Docs](https://www.codecademy.com/resources/docs) GitHub repo!
3
+
> **[Contribute to Docs](https://www.codecademy.com/pages/contribute-docs)!** Please see our updated **[Contribution Guide](https://www.codecademy.com/resources/docs/contribution-guide)** that provides a step-by-step video and text guide on how you can make an impact through Docs. 🌠
4
+
5
+
Welcome to the [Docs](https://www.codecademy.com/resources/docs) GitHub repo!
4
6
5
7
We are an inclusive and passionate team of technologists and life-long learners around the world building free programming resources for a better tomorrow. For newcomers, contributing to an open-source project for the first time can be intimidating and overwhelming. Perhaps you’re a code newbie or maybe you’ve been tinkering for years but haven’t found that special project yet.
6
8
7
-
Good news, you are in the right place! Codecademy Docs is the perfect open-contribution project for you to get started. Every part of [Codecademy Docs](https://www.codecademy.com/resources/docs) content (entries, documentation, and translations) is written by amazing creative folks like yourself.
9
+
Good news, you are in the right place! Docs is the perfect open-contribution project for you to get started. Every part of [Docs](https://www.codecademy.com/resources/docs) content (entries, documentation, and translations) is written by amazing creative folks like yourself.
8
10
9
11
Thanks for your interest; we'd love to have you contribute. 💖
10
12
11
13
## How do I contribute?
12
14
13
-
There are many ways to contribute to Codecademy Docs:
15
+
There are many ways to contribute to Docs:
14
16
15
17
- Submit a Pull Request to edit an existing entry.
16
18
- Submit a Pull Request to create a new entry.
17
19
- Submit a bug in [GitHub Issues](https://github.com/Codecademy/docs/issues).
18
20
- Give feedback in the [Typeform Survey](https://codecademyready.typeform.com/to/hzVIWDgz).
19
21
- Join the [#CodecademyDocs](https://twitter.com/search?q=%23CodecademyDocs&src=typed_query&f=live) discussion on Twitter.
20
22
21
-
If you're new to Codecademy Docs and contributing for the first time, it is recommended that you visit the [Issues](https://github.com/Codecademy/docs/issues) section and ask to be assigned to an [open issue](https://github.com/Codecademy/docs/blob/main/.github/CONTRIBUTING.md#how-do-i-claim-an-issue) that interests you. Otherwise, feel free to submit a [PR](https://www.codecademy.com/resources/docs/git/pull-requests) by creating a new [branch](https://www.codecademy.com/resources/docs/git/branch) in your fork to create a new entry or edit an existing one.
23
+
If you're new to Docs and contributing for the first time, it is recommended that you visit the [Issues](https://github.com/Codecademy/docs/issues) section and ask to be assigned to an [open issue](https://github.com/Codecademy/docs/blob/main/.github/CONTRIBUTING.md#how-do-i-claim-an-issue) that interests you. Otherwise, feel free to submit a [PR](https://www.codecademy.com/resources/docs/git/pull-requests) by creating a new [branch](https://www.codecademy.com/resources/docs/git/branch) in your fork to create a new entry or edit an existing one.
22
24
23
25
## How do I claim an Issue?
24
26
@@ -98,7 +100,7 @@ The following are templates for creating your new entries:
98
100
99
101
### Codecademy Username
100
102
101
-
As a Codecademy Docs contributor, you have the opportunity to have your Codecademy username displayed on the side of the entry!
103
+
As a Docs contributor, you have the opportunity to have your Codecademy username displayed on the side of the entry!
102
104
103
105
If you wish to have your Codecademy profile listed in the entry, before making the PR, make sure that your Codecademy user profile and your GitHub are linked, and that your Codecademy profile is set to public. You can stay anonymous by not linking them.
104
106
@@ -136,7 +138,7 @@ We will not accept entries that were exclusively generated through an AI tool. W
136
138
137
139
- AI-generated content is often confidently incorrect, leading to the spread of inaccurate or misleading information.
138
140
- We provide authorship credit for submissions, and to submit AI-generated work under one's own name would be a violation of our plagiarism policy.
139
-
-Codecademy Docs is an educational space for people to learn how to write effective technical documentation. Using generative AI, at this point, negatively impacts that desired learning goal.
141
+
- Docs is an educational space for people to learn how to write effective technical documentation. Using generative AI, at this point, negatively impacts that desired learning goal.
140
142
141
143
## How do we update a PR branch?
142
144
@@ -157,7 +159,7 @@ git push
157
159
158
160
## Additional Resources
159
161
160
-
-[How to Contribute to Codecademy Docs](https://dev.to/codecademy/how-to-contribute-to-codecademy-docs-1a77) article
162
+
-[How to Contribute to Docs](https://dev.to/codecademy/how-to-contribute-to-codecademy-docs-1a77) article
161
163
162
164
Remember, if you ever have any questions at all, we're always here to help in the [Codecademy Forums](https://discuss.codecademy.com/c/community/community-docs/2205) and [Codecademy Discord](https://discord.com/invite/codecademy).
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
<!-- markdownlint-disable MD041 MD002 -->
2
2
<divalign="center">
3
-
<h1>📕 Codecademy Docs</h1>
3
+
<h1>📕 Docs</h1>
4
4
<strong>Documentation for popular programming languages and frameworks.</strong><br>
5
5
<strong>Built by the community. Maintained by Codecademy.</strong>
6
6
</div>
7
7
<br>
8
8
9
9
## What is Docs?
10
10
11
-
[Codecademy Docs](https://www.codecademy.com/resources/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 Codecademy Doc entry, and have an answer in seconds.
11
+
[Docs](https://www.codecademy.com/resources/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.
12
12
13
13
## What stage of development are we in right now?
14
14
@@ -23,7 +23,7 @@ Docs is live with over 1000 high-quality entries. Now that the MVP is out, our g
We are currently building a team of community volunteers and educators to maintain Codecademy Docs. Let us know if you are interested.
26
+
We are currently building a team of community volunteers and educators to maintain Docs. Let us know if you are interested.
27
27
28
28
### 🏗 Engineering Team
29
29
@@ -35,17 +35,17 @@ We are currently building a team of community volunteers and educators to mainta
35
35
36
36
## How do I contribute?
37
37
38
-
There are many ways to contribute to Codecademy Docs:
38
+
There are many ways to contribute to Docs:
39
39
40
40
- Submit a Pull Request to edit an existing entry.
41
41
- Submit a Pull Request to create a new entry.
42
42
- Submit a typo/bug in [GitHub Issues](https://github.com/Codecademy/docs/issues).
43
-
-Share your thoughts in this [Codecademy Docs feedback form](https://codecademyready.typeform.com/to/hzVIWDgz) to tell us how we can improve Docs!
44
-
-Join the [#CodecademyDocs](https://twitter.com/search?q=%23CodecademyDocs&src=typed_query&f=live) discussion on Twitter.
43
+
-Reply to the thread on [Possible Content Discussion](https://discuss.codecademy.com/t/find-a-starting-point-possible-content-discussion/745868) to share ideas and collaborate with other contributors, maintainers, or super users to determine good future issues.
44
+
-Share your thoughts in this [Docs feedback form](https://codecademyready.typeform.com/to/hzVIWDgz) to tell us how we can improve Docs!
45
45
46
46
Whether you are a code newbie or a seasoned hacker, there's something for you!
47
47
48
-
Please read through the [Contribution Guide](https://github.com/Codecademy/docs/blob/main/.github/CONTRIBUTING.md) ✨. There you'll find a write-up of our content standards and style guide, as well as templates for creating your entries.
48
+
Please read through the [Contribution Guide](https://www.codecademy.com/resources/docs/contribution-guide) ✨. There you'll find a write-up of our content standards and style guide, as well as templates for creating your entries.
0 commit comments