technote-toml-present (TN004)#

Group	Default severity
Structural	Error

The linted directory must contain a technote.toml file. This file is what makes a directory a technote — it holds the document’s identity and metadata — so when it is missing the remaining rules cannot run and the linter stops with only this finding.

Illustration of a failing repository#

This is a repository/filesystem condition rather than a content problem. Either the command was run from the wrong directory, or the repository predates technote.toml:

sqr-000/               # legacy technote layout — no technote.toml
├── metadata.yaml
├── index.rst
├── conf.py
└── requirements.txt

[TN004] technote.toml not found in /path/to/sqr-000.

How to fix it#

First check where you ran the command: it lints the current directory by default, so run it from the technote repository’s root (or point at it with --dir):

documenteer technote lint --dir path/to/technote

If the repository genuinely has no technote.toml but has a metadata.yaml, it is a legacy technote. Migrate it to the modern format, which creates technote.toml:

documenteer technote migrate

See also#

TN005 — technote.toml exists but is not valid TOML.
Migrate legacy reStructuredText/Sphinx technical notes — migrating a legacy technote to the modern format.