fix(docs): update terminology for challenges (#42595)
Shaun Hamilton
GitHub
parent
7defcaf58e
commit
b96ebf7663
|
|
@ -32,10 +32,10 @@ Before you work on the curriculum, you would need to set up some tooling to help
|
|||
### How to work on practice projects
|
||||
|
||||
The practice projects have some additional tooling to help create new projects and steps. To read more, see [these docs](how-to-work-on-practice-projects.md)
|
||||
|
||||
## Challenge Template
|
||||
|
||||
````md
|
||||
|
||||
---
|
||||
id: Unique identifier (alphanumerical, MongoDB_id)
|
||||
title: 'Challenge Title'
|
||||
|
|
@ -49,9 +49,7 @@ forumTopicId: 12345
|
|||
Challenge description text, in markdown
|
||||
|
||||
```html
|
||||
<div>
|
||||
example code
|
||||
</div>
|
||||
<div>example code</div>
|
||||
```
|
||||
|
||||
# --instructions--
|
||||
|
|
@ -92,9 +90,7 @@ Boilerplate code to render to the editor. This section should only contain code
|
|||
|
||||
```html
|
||||
<body>
|
||||
<p class="main-text">
|
||||
Hello world!
|
||||
</p>
|
||||
<p class="main-text">Hello world!</p>
|
||||
</body>
|
||||
```
|
||||
|
||||
|
|
@ -156,8 +152,6 @@ More answers
|
|||
## --video-solution--
|
||||
|
||||
The number for the correct answer goes here.
|
||||
|
||||
|
||||
````
|
||||
|
||||
> [!NOTE]
|
||||
|
|
@ -231,7 +225,7 @@ Proper nouns should use correct capitalization when possible. Below is a list of
|
|||
|
||||
- JavaScript (capital letters in "J" and "S" and no abbreviations)
|
||||
- Node.js
|
||||
- Front-end development (adjective form with a dash) is when you're working on the front end (noun form with no dash). The same goes with "back end", "full stack", and many other compound terms.
|
||||
- Although sometimes inaccurate, non-hyphenated forms of 'back end' and 'front end' should be used, as they are more widely used.
|
||||
|
||||
### The 2-minute rule
|
||||
|
||||
|
|
@ -260,9 +254,11 @@ Here are specific formatting guidelines for challenge text and examples:
|
|||
|
||||
- Language keywords go in `\`` backticks. For example, HTML tag names or CSS property names.
|
||||
- References to code parts (i.e. function, method, or variable names) should be wrapped in `\`` backticks. See example below:
|
||||
|
||||
```md
|
||||
Use `parseInt` to convert the variable `realNumber` into an integer.
|
||||
```
|
||||
|
||||
- References to file names and path directories (e.g. `package.json`, `src/components`) should be wrapped in `\`` backticks.
|
||||
- Multi-line code blocks **must be preceded by an empty line**. The next line must start with three backticks followed immediately by one of the [supported languages](https://prismjs.com/#supported-languages). To complete the code block, you must start a new line which only has three backticks and **another empty line**. See example below:
|
||||
- Whitespace matters in Markdown, so we recommend that you make it visible in your editor.
|
||||
|
|
@ -270,6 +266,7 @@ Use `parseInt` to convert the variable `realNumber` into an integer.
|
|||
**Note:** If you are going to use an example code in YAML, use `yaml` instead of `yml` for the language to the right of the backticks.
|
||||
|
||||
The following is an example of code:
|
||||
|
||||
````md
|
||||
```{language}
|
||||
|
||||
|
|
@ -338,7 +335,7 @@ class MyComponent extends React.Component {
|
|||
constructor(props) {
|
||||
super(props);
|
||||
this.state = {
|
||||
text: "Hello"
|
||||
text: 'Hello'
|
||||
};
|
||||
// Change code below this line
|
||||
|
||||
|
|
@ -346,20 +343,20 @@ class MyComponent extends React.Component {
|
|||
}
|
||||
handleClick() {
|
||||
this.setState({
|
||||
text: "You clicked!"
|
||||
text: 'You clicked!'
|
||||
});
|
||||
}
|
||||
render() {
|
||||
return (
|
||||
<div>
|
||||
{ /* Change code below this line */ }
|
||||
{/* Change code below this line */}
|
||||
<button>Click Me</button>
|
||||
{ /* Change code above this line */ }
|
||||
{/* Change code above this line */}
|
||||
<h1>{this.state.text}</h1>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### Translation of seed code comments
|
||||
|
|
@ -372,7 +369,7 @@ Some comments may contain a word/phrase that should not be translated. For examp
|
|||
Declare the myGlobal variable below this line
|
||||
```
|
||||
|
||||
>[!NOTE]
|
||||
> [!NOTE]
|
||||
>
|
||||
> We are working on an integration to make it possible to work on i18n for the comment dictionary.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue