datadog-agent/doc/setup/optional.md
Ofek Lev 47e5a39d12
Move dev docs to a dedicated root directory (#56908)
### What does this PR do?

Moves the maintained Datadog Agent developer documentation from `docs/public/` to `doc/`, together with its site support files. Published page URLs stay the same.

### Motivation

AI coding agents use repository documentation to guide their changes. Moving maintained guidance into `doc/` gives them one directory to consult, with unfinished and deprecated pages kept in `docs/` until they are reviewed for incorporation or removal.

### Describe how you validated your changes

```text
$ dda run docs build
Syncing dependencies
Build started
No issues found
Build finished in 3.80s

$ dda run docs check-links
🔍 6852 Total (in 973ms) 🔗 989 Unique ✅ 6566 OK 🚫 0 Errors 👻 200 Excluded ⛔ 86 Unsupported


$ dda inv linter.docs-links
Synchronizing dependencies
The documentation references this repository properly

$ dda inv invoke-unit-tests.run --tests=docs_repo_links,docs_links
Synchronizing dependencies
................................
----------------------------------------------------------------------
Ran 32 tests in 0.087s

OK
...
----------------------------------------------------------------------
Ran 3 tests in 0.024s

OK
Running tests from module docs_repo_links_tests

Running tests from module docs_links_tests
```

### Additional Notes

`docs/README.md` lists every retained page and its reason. Unpublished pages, deprecated component guidance, and empty placeholders remain temporarily while their content is reviewed for removal or incorporation.

Co-authored-by: ofek.lev <ofek.lev@datadoghq.com>
2026-09-25 15:18:19 +00:00

672 B

Set up optional development features


Tab completion

<<<DDA_DOCS_TAB_COMPLETE>>>

/// tip There is also limited tab completion support for the legacy invoke tasks. Here's an example:

echo "source <(dda inv --print-completion-script zsh)" >> ~/.zshrc

///

Pre-commit hooks

The CI runs a number of required checks using pre-commit and running those locally can speed up the development process.

  1. Install pre-commit by running the following command.

    ```
    dda self pip install pre-commit
    ```
    
  2. Use dda to configure the pre-commit hooks.

    ```
    dda inv setup.pre-commit
    ```