From 3562e872530b3610d95be71aa6f4f7fdfef7134f Mon Sep 17 00:00:00 2001
From: Matt Mayer <152770+matthewmayer@users.noreply.github.com>
Date: Wed, 29 Mar 2023 20:36:46 +0700
Subject: docs: add overview guides to specific modules (#1929)

---
 src/modules/hacker/index.ts | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src/modules/hacker')

diff --git a/src/modules/hacker/index.ts b/src/modules/hacker/index.ts
index 00b9a686..ef0aa013 100644
--- a/src/modules/hacker/index.ts
+++ b/src/modules/hacker/index.ts
@@ -2,6 +2,18 @@ import type { Faker } from '../..';
 
 /**
  * Module to generate hacker/IT words and phrases.
+ *
+ * ### Overview
+ *
+ * There are methods for different parts of speech, such as [`abbreviation()`](https://next.fakerjs.dev/api/hacker.html#abbreviation), [`adjective()`](https://next.fakerjs.dev/api/hacker.html#adjective), [`noun()`](https://next.fakerjs.dev/api/hacker.html#noun), [`verb()`](https://next.fakerjs.dev/api/hacker.html#verb), and [`ingverb()`](https://next.fakerjs.dev/api/hacker.html#ingverb). Alternatively, [`phrase()`](https://next.fakerjs.dev/api/hacker.html#phrase) creates a longer phrase combining these words.
+ *
+ * ### Related modules
+ *
+ * Various modules allow for generating other types of words and phrases:
+ *
+ * - [faker.word](https://next.fakerjs.dev/api/word.html) uses general vocabulary rather than hacker-specific terms.
+ * - [faker.lorem](https://next.fakerjs.dev/api/lorem.html) uses faux-Latin "lorem ipsum" text.
+ * - [faker.company](https://next.fakerjs.dev/api/company.html) includes corporate catchphrases and buzzwords.
  */
 export class HackerModule {
   constructor(private readonly faker: Faker) {
-- 
cgit v1.2.3