> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/demisto-sdk-development-guide/demisto-sdk-guide/demisto-sdk-commands/doc-review.md).

# doc-review

Checks the spelling in Markdown and YAML files and compares release note files to our release note standards.

<details>

<summary>Arguments</summary>

| `-i, --input`                                                  | Path to the file to check.                                                                                                                           |
| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-g, --use-git`                                                | Uses Git to identify the relevant changed files. This option is used by default if `-i` and `--templates` are not set.                               |
| `--prev-ver`                                                   | The branch against which changes are detected if `-g` flag is set. Default is `demisto/master`.                                                      |
| `--no-camel-case`                                              | Whether to run spell check on words in `CamelCase`.                                                                                                  |
| `--known-words`                                                | The path to a file containing a list of known words.                                                                                                 |
| `--always-true`                                                | Whether the command should fail if misspelled words are found.                                                                                       |
| `--expand-dictionary`                                          | Whether to expand the base dictionary to include more words. If this option is used, it will download Brown and Webtext corpora from `nltk` package. |
| `--templates`                                                  | Whether to print release notes templates.                                                                                                            |
| `-rn, --release-notes`                                         | Runs only on release notes files.                                                                                                                    |
| `-clt, --console-log-threshold`                                | Minimum logging threshold for the console logger. Default value is `INFO`. Possible values are `DEBUG`, `INFO`, `WARNING`, `ERROR`.                  |
| `-flt, --file-log-threshold`                                   | Minimum logging threshold for the file logger. Default value is `DEBUG`. Possible values are `DEBUG`, `INFO`, `WARNING`, `ERROR`.                    |
| `-lp, --log-file-path`                                         | The path to the log file. Default path is `<CONTENT_PATH>/demisto_sdk_debug.log`.                                                                    |
| `-xs, --xsoar-only`                                            | Runs only on files from Cortex XSOAR-supported packs.                                                                                                |
| `-pkw/-spkw, --use-packs-known-words/--skip-packs-known-words` | Finds and loads the `known_words` file from the pack. To use this option, ensure you are running from the content directory.                         |

</details>

<details>

<summary>Examples</summary>

* `demisto-sdk doc-review -i ~/Integrations/integration-MyInt.yml --no-camel-case`

  Checks the spelling in the given integration file and treats camel case words as misspelled words.
* `demisto-sdk doc-review -i Packs/MyPack/Scripts --expand-dictionary`

  Spell checks all eligible files under the `Packs/MyPack/Scripts` directory. Also downloads and uses the Brown and Webtext corpora from the `nltk` package.
* `demisto-sdk doc-review -i ~/Integrations/MyIntegration/README.md --known-words ~/Integrations/additional_words.txt`

  Spell checks the given `README.md` file as well as expands the known words with the word list found in the `additional_words.txt` file.
* `demisto-sdk doc-review --templates`

  Prints the documentation template examples.
* `demisto-sdk doc-review --prev-ver myRemote/master -rn`

  Performs a documentation review on all the release notes that were changed (added or modified) when compared to `myRemote/master` using Git.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/demisto-sdk-development-guide/demisto-sdk-guide/demisto-sdk-commands/doc-review.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.