Skip to content

Commit 371b09d

Browse files
metadata edits (#3007)
Co-authored-by: SSwiniarski <[email protected]>
1 parent 231cef8 commit 371b09d

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

documentation/concept-entry-template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Title: 'The Title' # Required; the file name should be the same as the title, but lowercase, with dashes instead of spaces, and all punctuation removed
3-
Description: 'A brief description' # Required; ideally under 150 characters and starts with a noun (used in search engine results and content previews)
3+
Description: 'A brief description.' # Required; ideally under 150 characters and starts with a noun (used in search engine results and content previews)
44
Subjects: # Please only use Subjects in the subjects.md file (https://github.com/Codecademy/docs/blob/main/documentation/subjects.md). If that list feels insufficient, feel free to create a new Subject and add it to subjects.md in your PR!
55
- 'A subject name'
66
- 'A second subject name'
@@ -11,7 +11,7 @@ Tags: # Please only use Tags in the tags.md file (https://github.com/Codecademy/
1111
- 'An nth tag'
1212
CatalogContent: # Please use course/path landing page slugs, rather than linking to individual content items. If listing multiple items, please put the most relevant one first
1313
- 'learn-example-course'
14-
- 'path/example-path'
14+
- 'paths/example-path'
1515
---
1616

1717
[Introduction - make sure first mention of concept is in **bold**.] (The first 160 characters of this section will appear as the description of the page when it shows up on search engines. It's important!)

documentation/term-entry-template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Title: 'The Title' # Required; the file name should be the same as the title, but lowercase, with dashes instead of spaces, and all punctuation removed
3-
Description: 'A brief description' # Required; ideally under 150 characters and starts with a present-tense verb (used in search engine results and content previews)
3+
Description: 'A brief description.' # Required; ideally under 150 characters and starts with a present-tense verb (used in search engine results and content previews)
44
Subjects: # Please only use Subjects in the subjects.md file (https://github.com/Codecademy/docs/blob/main/documentation/subjects.md). If that list feels insufficient, feel free to create a new Subject and add it to subjects.md in your PR!
55
- 'A subject name'
66
- 'A second subject name'
@@ -11,7 +11,7 @@ Tags: # Please only use Tags in the tags.md file (https://github.com/Codecademy/
1111
- 'An nth tag'
1212
CatalogContent: # Please use course/path landing page slugs, rather than linking to individual content items. If listing multiple items, please put the most relevant one first
1313
- 'learn-example-course'
14-
- 'path/example-path'
14+
- 'paths/example-path'
1515
---
1616

1717
[A brief definition - make sure first mention of term is in **bold**.]

documentation/topic-entry-template.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
# This file is used to populate the hub page for the language whose folder it's in. Be sure to create a new version if you create a folder for a new language!
33

44
Title: 'Name' # Required; this is the name that appears on the hub page for this language. Pay attention to capitalization and punctuation!
5-
Description: 'A brief description' # Required; ideally under 150 characters and starts with the name of the topic (used in search engine results and content previews)
5+
Description: 'A brief description.' # Required; ideally under 150 characters and starts with the name of the topic (used in search engine results and content previews)
66
Codecademy Hub Page: 'https://www.codecademy.com/catalog/language/_____' # If codecademy.com doesn't have a hub page for this language, that's okay too. You can omit this field.
77
CatalogContent: # Please use course/path landing page slugs, rather than linking to individual content items. If listing multiple items, please put the most relevant one first
88
- 'learn-example-course'
9-
- 'path/example-path'
9+
- 'paths/example-path'
1010
---
1111

12-
[Text description - make sure first mention of topic is in **bold**.] <!-- # Write up an introductory description of the language/framework here! -->
12+
[Text description - make sure first mention of the topic is in **bold**.] <!-- # Write up an introductory description of the language/framework here! -->

0 commit comments

Comments
 (0)