annotate the root entry point

cucumber · Dec 27, 2023 · 72dda13 · 72dda13
1 parent 0fcaa33
commit 72dda13
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,11 @@
+/**
+ * User code functions and helpers
+ *
+ * @packageDocumentation
+ * @module (root)
+ * @remarks These docs cover the API for user code registration and test setup. The entry point is `@cucumber/cucumber`.
+ */
+
 import { deprecate } from 'node:util'
 import * as messages from '@cucumber/messages'
 import { default as _Cli } from './cli'