docs: add overview guides to specific modules (#1929)

1 files changed, 18 insertions, 1 deletions

diff --git a/src/modules/person/index.ts b/src/modules/person/index.ts
index d7d2d3c9..b1722bc0 100644
--- a/src/modules/person/index.ts
+++ b/src/modules/person/index.ts
@@ -54,7 +54,24 @@ function selectDefinition<T>(
 }
 
 /**
- * Module to generate people's names and titles.
+ * Module to generate people's personal information such as names and job titles. Prior to Faker 8.0.0, this module was known as `faker.name`.
+ *
+ * ### Overview
+ * 
+ * To generate a full name, use [`fullName`](https://next.fakerjs.dev/api/person.html#fullname). Note that this is not the same as simply concatenating [`firstName`](https://next.fakerjs.dev/api/person.html#firstname) and [`lastName`](https://next.fakerjs.dev/api/person.html#lastname), as the full name may contain a prefix, suffix, or both. Additionally, different supported locales will have differing name patterns. For example, the last name may appear before the first name, or there may be a double or hyphenated first or last name.
+ * 
+ * You can also generate the parts of a name separately, using [`prefix`](https://next.fakerjs.dev/api/person.html#prefix), [`firstName`](https://next.fakerjs.dev/api/person.html#firstname), [`middleName`](https://next.fakerjs.dev/api/person.html#middlename), [`lastName`](https://next.fakerjs.dev/api/person.html#lastname), and [`suffix`](https://next.fakerjs.dev/api/person.html#suffix). Not all locales support all of these parts.
+ *
+ * Many of the methods in this module can optionally choose either female, male or mixed names.
+ *
+ * Job-related data is also available. To generate a job title, use [`jobTitle`](https://next.fakerjs.dev/api/person.html#jobtitle). 
+ * 
+ * This module can also generate other personal information which might appear in user profiles, such as [`gender`](https://next.fakerjs.dev/api/person.html#gender), [`zodiacSign`](https://next.fakerjs.dev/api/person.html#zodiacsign), and [`bio`](https://next.fakerjs.dev/api/person.html#bio).
+ * 
+ * ### Related modules
+ *
+ * For personal contact information like phone numbers and email addresses, see the [`faker.phone`](https://next.fakerjs.dev/api/phone.html) and [`faker.internet`](https://next.fakerjs.dev/api/internet.html) modules.
+ 
  */
 export class PersonModule {
   constructor(private readonly faker: Faker) {