Skip to content

Commit 3249c07

Browse files
bndiepyangc95
andauthored
[REACH-2674] Update README and CONTRIBUTING.md with links to new guide (Codecademy#2202)
* replace instances of Codecademy Docs and reference new contribution guide * Update CONTRIBUTING.md * Update README.md --------- Co-authored-by: Christine Yang <[email protected]>
1 parent 2b53ba7 commit 3249c07

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

.github/CONTRIBUTING.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
# Codecademy Docs: Contribution Guide 👩🏻‍💻👨🏾‍💻👩🏼‍💻
1+
# Docs: Contribution Guide 👩🏻‍💻👨🏾‍💻👩🏼‍💻
22

3-
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!
46

57
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.
68

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.
810

911
Thanks for your interest; we'd love to have you contribute. 💖
1012

1113
## How do I contribute?
1214

13-
There are many ways to contribute to Codecademy Docs:
15+
There are many ways to contribute to Docs:
1416

1517
- Submit a Pull Request to edit an existing entry.
1618
- Submit a Pull Request to create a new entry.
1719
- Submit a bug in [GitHub Issues](https://github.com/Codecademy/docs/issues).
1820
- Give feedback in the [Typeform Survey](https://codecademyready.typeform.com/to/hzVIWDgz).
1921
- Join the [#CodecademyDocs](https://twitter.com/search?q=%23CodecademyDocs&src=typed_query&f=live) discussion on Twitter.
2022

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.
2224

2325
## How do I claim an Issue?
2426

@@ -98,7 +100,7 @@ The following are templates for creating your new entries:
98100

99101
### Codecademy Username
100102

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!
102104

103105
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.
104106

@@ -136,7 +138,7 @@ We will not accept entries that were exclusively generated through an AI tool. W
136138

137139
- AI-generated content is often confidently incorrect, leading to the spread of inaccurate or misleading information.
138140
- 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.
140142

141143
## How do we update a PR branch?
142144

@@ -157,7 +159,7 @@ git push
157159

158160
## Additional Resources
159161

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
161163

162164
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).
163165

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!-- markdownlint-disable MD041 MD002 -->
22
<div align="center">
3-
<h1>📕 Codecademy Docs</h1>
3+
<h1>📕 Docs</h1>
44
<strong>Documentation for popular programming languages and frameworks.</strong><br>
55
<strong>Built by the community. Maintained by Codecademy.</strong>
66
</div>
77
<br>
88

99
## What is Docs?
1010

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.
1212

1313
## What stage of development are we in right now?
1414

@@ -23,7 +23,7 @@ Docs is live with over 1000 high-quality entries. Now that the MVP is out, our g
2323
- [@sswiniarski](https://github.com/sswiniarski), Content Contributor
2424
- [@yangc95](https://github.com/yangc95), Content Contributor
2525

26-
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.
2727

2828
### 🏗 Engineering Team
2929

@@ -35,17 +35,17 @@ We are currently building a team of community volunteers and educators to mainta
3535

3636
## How do I contribute?
3737

38-
There are many ways to contribute to Codecademy Docs:
38+
There are many ways to contribute to Docs:
3939

4040
- Submit a Pull Request to edit an existing entry.
4141
- Submit a Pull Request to create a new entry.
4242
- 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!
4545

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

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.
4949

5050
## Additional Notes
5151

0 commit comments

Comments
 (0)