docs(configuration): suggests naming convention for config files

[bmuenzenmeyer]

Description

Suggest a convention based on a cold reading of the docs, initial setup, and evidence

Validation

Related Issues

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run node --run test and all tests passed.
• I have check code formatting with node --run format & node --run lint.
• I've covered new added functionality with unit tests if necessary.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Jun 24, 2026 12:57pm

[cursor]

PR Summary

Low Risk
Documentation-only change with no runtime or configuration behavior impact.

Overview
Documents a recommended filename for --config-file: doc-kit.config.mjs or doc-kit.config.json, placed right after the existing note that configs must be importable (JSON or ESM with default exports).

No CLI, defaults, or code behavior change—only guidance for users choosing a config path.

^{Reviewed by Cursor Bugbot for commit ab4dbf4. Bugbot is set up for automated code reviews on this repo. Configure here.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.60%. Comparing base (b5cf0a0) to head (ab4dbf4).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #851   +/-   ##
=======================================
  Coverage   84.60%   84.60%           
=======================================
  Files         176      176           
  Lines       15858    15858           
  Branches     1411     1411           
=======================================
  Hits        13417    13417           
  Misses       2431     2431           
  Partials       10       10           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

orama-db Generator

File	Base	Head	Diff
orama-db.json	8.89 MB	8.89 MB	+1.07 KB (+0.01%)