Skip to content

Commit

Permalink
Merge pull request #2330 from opensafely-core/update-explanation-docs
Browse files Browse the repository at this point in the history
Update explanation docs
  • Loading branch information
madwort authored Dec 19, 2024
2 parents 4e55108 + 81b8b97 commit 1f00a01
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
4 changes: 3 additions & 1 deletion docs/explanation/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
The explanation provides background knowledge for studying ehrQL.
These explanations provide background knowledge for learning ehrQL.

* [ehrQL backend tables](backend-tables.md)
* [ehrQL output formats](output-formats.md)
* [Using ehrQL in OpenSAFELY projects](using-ehrql-in-opensafely-projects.md)
* [Running ehrQL](running-ehrql.md)
* [Using the measures framework](measures.md)
* [Selecting populations for study](selecting-populations-for-study.md)
* [The OpenSAFELY VS Code extension](vscode-extension.md)
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ehrQL's documentation has four main sections:

1. The [reference](reference/index.md) provides background knowledge for working with ehrQL in your project.

1. The [explanation](explanation/index.md) provides background knowledge for studying ehrQL.
1. The [explanations](explanation/index.md) provide background knowledge for learning ehrQL.

### Conventions

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ nav:
- Command line interface: reference/cli.md
- Cheatsheet: reference/cheatsheet.md
- Upgrading ehrQL from v0 to v1: reference/upgrading-ehrql-from-v0-to-v1.md
- Explanation:
- Explanation: explanation/index.md
- Explanations:
- Explanations: explanation/index.md
- ehrQL backend tables: explanation/backend-tables.md
- ehrQL output formats: explanation/output-formats.md
- Using ehrQL in OpenSAFELY projects: explanation/using-ehrql-in-opensafely-projects.md
Expand Down

0 comments on commit 1f00a01

Please sign in to comment.