Skip to content

Commit

Permalink
fix: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@about-code
about-code committed Sep 12, 2022
1 parent 78d5656 commit 5bceaa5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -306,9 +306,10 @@ Sometimes you might whish to have multiple glossaries. For example as a Requirem

```md
## REQ-1: The system MUST provide service X
<!-- aliases: $2 ...
<!-- aliases: REQ-1 -->

## REQ-2: The system MAY provide service Y
<!-- aliases: $2 ...
<!-- aliases: REQ-2 -->
```

By adding *requirements.md* to the list of glossaries every use of *REQ-1* or *REQ-2* in documents gets linked to the requirements glossary. To navigate the opposite direction from a requirement to sections where those got mentioned you can generate a [Book Index](#book-index).
Expand Down
5 changes: 3 additions & 2 deletions md/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,10 @@ Sometimes you might whish to have multiple glossaries. For example as a Requirem

```md
## REQ-1: The system MUST provide service X
<!-- aliases: $2 ...
<!-- aliases: REQ-1 -->

## REQ-2: The system MAY provide service Y
<!-- aliases: $2 ...
<!-- aliases: REQ-2 -->
```

By adding *requirements.md* to the list of glossaries every use of *REQ-1* or *REQ-2* in documents gets linked to the requirements glossary. To navigate the opposite direction from a requirement to sections where those got mentioned you can generate a [Book Index](#book-index).
Expand Down

0 comments on commit 5bceaa5

Please sign in to comment.