Skip to content

Commit

Permalink
Improved writing
Browse files Browse the repository at this point in the history
  • Loading branch information
kordwarshuis committed Sep 10, 2024
1 parent f16e3fe commit bae2ad1
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/various-roles/general-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ sidebar_position: 1
# General Guide

:::info
This is a temporary page; parts will be moved to other pages and assigned to the various roles.
This page is temporary; parts will be moved to other pages and assigned to the various roles.
:::


## Start command line menu

Assuming you already [installed](admins-guide/#installation) Spec-Up-T, here you find further instructions:
Expand All @@ -32,7 +31,7 @@ Please choose one of the following options:
[Q] Quit
```

These menu options act as shortcuts to the commands covered below, such as `npm run render` and others. You can choose between using the menu or entering the direct commands yourself.
These menu options act as shortcuts to the below commands, such as `npm run render` and others. You can choose between using the menu or entering the direct commands yourself.

### Option [1] Render specification

Expand All @@ -42,7 +41,7 @@ Direct command:
npm run render
```

Creates the specification which is an index.html, in the `docs` directory, as specified in the `specs.json` file.
Creates the specification, an index.html, in the `docs` directory, as specified in the `specs.json` file.

To view the `index.html` file, you can:

Expand Down Expand Up @@ -79,7 +78,7 @@ Direct command:
npm run xrefs
```

`xrefs` are references to external glossaries (specifications). Each `xref` is checked against a local data collection to see if a reference already exists, maintaining the original version of an external term.
`xrefs` are references to external glossaries (specifications). Each `xref` is checked against a local data collection to see if a reference exists, maintaining an external term's original version.


### Option [4] Remove xref
Expand Down Expand Up @@ -112,7 +111,7 @@ Direct command:
npm run addterms
```

If you create a new markdown file with a term and definition in it, it is not automatically included in the final product. Only if you want it can it be included in the index. With this command you add it to the index.
If you create a new Markdown file with a term and definition in it, it is not automatically included in the final product. It can be included in the index only if you want it to be. With this command, you add it to the index.


### Option [7] Open documentation website
Expand All @@ -125,7 +124,7 @@ This command will redirect to the documentation website (the site you are readin

This command will take you out of the menu.

**This is the end of the explanation of the menu.**
**This is the end of the menu explanation.**

- - -

Expand Down

0 comments on commit bae2ad1

Please sign in to comment.