3.6.0 Release

README.md

@@ -335,9 +335,11 @@ of different hooks that will be called at different stages of the documentation
 
 All hooks can be async functions, allowing you to make asynchronous operations, like calling an external API.
 
-📒 Note: The extension hook functions are only available when generating Markdown files (not OpenApi).
+There are hooks for both Markdown and Changelog operations (but not for OpenApi).
 
-#### **transformReferenceGuide**
+#### Markdown Hooks
+
+##### **transformReferenceGuide**
 
 Allows changing the Allows changing the frontmatter and content of the reference guide, or even if creating a reference
 guide page should be skipped.
@@ -374,7 +376,7 @@ export default defineMarkdownConfig({
 });
 ```
 
-#### **transformDocs**
+##### **transformDocs**
 
 The main purpose of this hook is to allow you to skip the generation of specific pages,
 by returning a filtered array of `DocPageData` objects.
@@ -397,7 +399,7 @@ export default {
 };
 ```
 
-#### **transformDocPage**
+##### **transformDocPage**
 
 Allows changing the frontmatter and content of the doc page.
 
@@ -421,7 +423,7 @@ export default {
 };
 ```
 
-#### **transformReference**
+##### **transformReference**
 
 Allows changing where the files are written to and how files are linked to each other.
 
@@ -449,6 +451,32 @@ export default {
 };
 ```
 
+#### Changelog Hooks
+
+##### **transformChangeLogPage**
+
+Allows changing the frontmatter and content of the changelog page.
+
+**Type**
+
+```typescript
+type TransformChangeLogPage = (
+  changelog: ChangeLogPageData,
+) => Partial<ChangeLogPageData> | Promise<Partial<ChangeLogPageData>>
+```
+
+Example
+
+```typescript
+export default {
+  transformChangeLogPage: (changelog) => {
+    return {
+      frontmatter: { example: 'example' }
+    };
+  }
+};
+```
+
 ## ⤵︎ Importing to your project
 
 ### Reflection

examples/vitepress/apexdocs.config.ts

@@ -30,6 +30,13 @@ export default {
     previousVersionDir: 'previous',
     currentVersionDir: 'force-app',
     scope: ['global', 'public', 'protected', 'private', 'namespaceaccessible'],
+    transformChangeLogPage: () => {
+      return {
+        frontmatter: {
+          title: 'Changelog',
+        },
+      };
+    },
   }),
   markdown: defineMarkdownConfig({
     sourceDir: 'force-app',

examples/vitepress/docs/.vitepress/sidebar.json

@@ -58,6 +58,10 @@
   {
     "text": "Object Reference",
     "items": [
+      {
+        "text": "Contact",
+        "link": "custom-objects/Contact.md"
+      },
       {
         "text": "Event__c",
         "link": "custom-objects/Event__c.md"
@@ -70,6 +74,10 @@
         "text": "Product__c",
         "link": "custom-objects/Product__c.md"
       },
+      {
+        "text": "Product_Inline_Fields__c",
+        "link": "custom-objects/Product_Inline_Fields__c.md"
+      },
       {
         "text": "Product_Price_Component__c",
         "link": "custom-objects/Product_Price_Component__c.md"

examples/vitepress/docs/changelog.md

@@ -1,3 +1,7 @@
+---
+title: Changelog
+---
+
 # Changelog
 
 ## New Classes
@@ -51,6 +55,9 @@ These custom objects are new.
 Represents an event that people can register for.
 ### Price_Component__c
 
+### Product_Inline_Fields__c
+
+Products
 ### Product_Price_Component__c
 
 ### Product__c
@@ -64,4 +71,12 @@ Represents a line item on a sales order.
 Custom object for tracking sales orders.
 ### Speaker__c
 
-Represents a speaker at an event.
+Represents a speaker at an event.
+
+## New or Removed Fields to Custom Objects or Standard Objects
+
+These custom fields have been added or removed.
+
+### Contact
+
+- New Field: PhotoUrl__c. URL of the contact's photo

examples/vitepress/docs/custom-objects/Contact.md

@@ -0,0 +1,21 @@
+---
+title: Contact
+---
+
+# Contact
+
+## API Name
+`apexdocs__Contact`
+
+## Fields
+### PhotoUrl
+
+URL of the contact's photo
+
+**API Name**
+
+`apexdocs__PhotoUrl__c`
+
+**Type**
+
+*Url*

examples/vitepress/docs/custom-objects/Event__c.md

@@ -22,6 +22,7 @@ Represents an event that people can register for.
 
 ---
 ### End Date
+**Required**
 
 **API Name**
 
@@ -33,6 +34,7 @@ Represents an event that people can register for.
 
 ---
 ### Location
+**Required**
 
 **API Name**
 
@@ -44,6 +46,7 @@ Represents an event that people can register for.
 
 ---
 ### Start Date
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Price_Component__c.md

@@ -59,6 +59,7 @@ Use this when the Price Component represents a Flat Price. To represent a Percen
 
 ---
 ### Type
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Product_Inline_Fields__c.md

@@ -0,0 +1,114 @@
+---
+title: Product_Inline_Fields__c
+---
+
+# Products
+
+Products
+
+## API Name
+`apexdocs__Product_Inline_Fields__c`
+
+## Fields
+### DiscontinuedDate
+
+The date the product got discontinued
+
+**API Name**
+
+`apexdocs__DiscontinuedDate__c`
+
+**Type**
+
+*DateTime*
+
+---
+### ID
+
+**API Name**
+
+`apexdocs__ID__c`
+
+**Type**
+
+*Number*
+
+---
+### Name
+**Required**
+
+Product name
+
+**API Name**
+
+`apexdocs__Name__c`
+
+**Type**
+
+*Text*
+
+---
+### Price
+
+Product price in the default currency
+
+**API Name**
+
+`apexdocs__Price__c`
+
+**Type**
+
+*Number*
+
+---
+### Products
+
+**API Name**
+
+`apexdocs__Products__c`
+
+**Type**
+
+*ExternalLookup*
+
+---
+### Rating
+
+Rating
+
+**API Name**
+
+`apexdocs__Rating__c`
+
+**Type**
+
+*Number*
+
+---
+### ReleaseDate
+
+ReleaseDate
+
+**API Name**
+
+`apexdocs__ReleaseDate__c`
+
+**Type**
+
+*DateTime*
+
+---
+### Type
+**Required**
+
+**API Name**
+
+`apexdocs__Type__c`
+
+**Type**
+
+*Picklist*
+
+#### Possible values are
+* Merchandise
+* Bundle

examples/vitepress/docs/custom-objects/Product__c.md

@@ -22,6 +22,7 @@ Product that is sold or available for sale.
 
 ---
 ### Event
+**Required**
 
 **API Name**
 

examples/vitepress/docs/custom-objects/Sales_Order_Line__c.md

@@ -11,6 +11,7 @@ Represents a line item on a sales order.
 
 ## Fields
 ### Amount
+**Required**
 
 **API Name**
 
@@ -22,6 +23,7 @@ Represents a line item on a sales order.
 
 ---
 ### Product
+**Required**
 
 **API Name**
 
@@ -55,6 +57,7 @@ Represents a line item on a sales order.
 
 ---
 ### Type
+**Required**
 
 **API Name**
 

examples/vitepress/docs/index.md

@@ -19,6 +19,8 @@ hero:
 
 ## Custom Objects
 
+### [Contact](custom-objects/Contact)
+
 ### [Event__c](custom-objects/Event__c)
 
 Represents an event that people can register for.
@@ -29,6 +31,10 @@ Represents an event that people can register for.
 
 Product that is sold or available for sale.
 
+### [Product_Inline_Fields__c](custom-objects/Product_Inline_Fields__c)
+
+Products
+
 ### [Product_Price_Component__c](custom-objects/Product_Price_Component__c)
 
 ### [Sales_Order__c](custom-objects/Sales_Order__c)

examples/vitepress/docs/samplegroup/SampleClass.md

@@ -10,6 +10,8 @@ aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit
 
 **Group** SampleGroup
 
+**See** [Event__c](../custom-objects/Event__c)
+
 ## Namespace
 apexdocs
 

examples/vitepress/force-app/main/default/classes/feature-a/SampleClass.cls

@@ -2,6 +2,7 @@
  * @description aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
  *              **deserunt** ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
  * @group SampleGroup
+ * @see Event__c
  * @example
  * SampleClass sample = new SampleClass();
  * sample.doSomething();

examples/vitepress/force-app/main/default/objects/Contact/fields/PhotoUrl__c.field-meta.xml

@@ -6,4 +6,5 @@
     <required>false</required>
     <trackFeedHistory>false</trackFeedHistory>
     <type>Url</type>
+    <description>URL of the contact's photo</description>
 </CustomField>