Skip to content

Commit

Permalink
fix: some errors in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kasir-barati committed Oct 30, 2024
1 parent ccee2ab commit dde752b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/docs/monorepo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ In [VCS](https://en.wikipedia.org/wiki/Version_control), a monorepo is:

- NPM packages.
- Build on top of the fundamental capabilities provided by the Nx.
- Contain code generators, executors (to abstract lower-level build tooling) and automated code migrations for keeping your tools up to date.
- Contain code generators, [executors](./glossary.md#executorDefinitionInGlossary) and automated code migrations for keeping your tools up to date.
- Are usually technology specific.
- Increases productive by removing any friction of integrating different tools with each other and by providing utilities to keep them up to date.
- Increases productivity by removing any friction of integrating different tools with each other and by providing utilities to keep them up to date.
- Use the `@nx/plugin` package to easily scaffold a new plugin or even just automate your local workspace.

### Devkit
Expand All @@ -40,11 +40,11 @@ In [VCS](https://en.wikipedia.org/wiki/Version_control), a monorepo is:
![Run a task](./tasks.png)

- Run multiple tasks: `npx nx --run-many targetName1 targetName2`
- <a href="#executorDefinitionInNx" id="executorDefinitionInNx">#</a> Each task has what we call it "executor": it is the tool or script used to run that target.
- Each task has what we call it ["executor"](./glossary.md#executorDefinitionInGlossary).
- Nx picks up tasks from:

1. `package.json` scripts.
2. Defined inside `project.json`.
2. Defined inside `project.json`/`nx.json`.

And their config:

Expand Down
5 changes: 5 additions & 0 deletions .github/docs/monorepo/glossary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Glossary

<dl>
<dt id="executorDefinitionInGlossary">
<a href="#executorDefinitionInGlossary">#</a>
Executors
</dt>
<dd>The tool or script used to run that target.</dd>
<dt id="projectRootDefinitionInNx">
<a href="#projectRootDefinitionInNx">#</a>
<code>projectRoot</code>
Expand Down

0 comments on commit dde752b

Please sign in to comment.