GitBook: [#189] updated changelog markdown formatting

raycast · Mar 21, 2022 · 0b3ba8c · 0b3ba8c
1 parent 8ab6d92
commit 0b3ba8c
Show file tree

Hide file tree

Showing 21 changed files with 18 additions and 12 deletions.
diff --git a/docs/.gitbook/assets/CleanShot 2021-09-21 at 3.29.22.mp4 b/docs/.gitbook/assets/CleanShot 2021-09-21 at 3.29.22.mp4
diff --git a/docs/.gitbook/assets/CleanShot 2021-10-19 at 23.15.41@2x.png b/docs/.gitbook/assets/CleanShot 2021-10-19 at 23.15.41@2x.png
diff --git a/docs/.gitbook/assets/CleanShot 2021-11-11 at 17.31.47@2x.png b/docs/.gitbook/assets/CleanShot 2021-11-11 at 17.31.47@2x.png
diff --git a/docs/.gitbook/assets/CleanShot 2021-12-02 at 11.32.09@2x.png b/docs/.gitbook/assets/CleanShot 2021-12-02 at 11.32.09@2x.png
diff --git a/docs/.gitbook/assets/Frame 18.png b/docs/.gitbook/assets/Frame 18.png
diff --git a/docs/.gitbook/assets/Frame 20.png b/docs/.gitbook/assets/Frame 20.png
diff --git a/docs/.gitbook/assets/blue (1).png b/docs/.gitbook/assets/blue (1).png
diff --git a/docs/.gitbook/assets/example-doppler-share-secrets (1).png b/docs/.gitbook/assets/example-doppler-share-secrets (1).png
diff --git a/docs/.gitbook/assets/example-hacker-news (1).png b/docs/.gitbook/assets/example-hacker-news (1).png
diff --git a/docs/.gitbook/assets/example-hacker-news (2).png b/docs/.gitbook/assets/example-hacker-news (2).png
diff --git a/docs/.gitbook/assets/folder-structure (1).png b/docs/.gitbook/assets/folder-structure (1).png
diff --git a/docs/.gitbook/assets/image (1).png b/docs/.gitbook/assets/image (1).png
diff --git a/docs/.gitbook/assets/image (2).png b/docs/.gitbook/assets/image (2).png
diff --git a/docs/.gitbook/assets/introduction-hello-world (1).png b/docs/.gitbook/assets/introduction-hello-world (1).png
diff --git a/docs/.gitbook/assets/screenshots-example (1).png b/docs/.gitbook/assets/screenshots-example (1).png
diff --git a/docs/.gitbook/assets/store-welcome.png b/docs/.gitbook/assets/store-welcome.png
diff --git a/docs/.gitbook/assets/welcome (1).png b/docs/.gitbook/assets/welcome (1).png
diff --git a/docs/api-reference/user-interface/form.md b/docs/api-reference/user-interface/form.md
@@ -1,6 +1,6 @@
 # Form
 
-![](../../.gitbook/assets/form.png)
+![](../../.gitbook/assets/example-doppler-share-secrets.png)
 
 ## API Reference
 

diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md
@@ -15,7 +15,7 @@ Before you can create your first extension, make sure you have the following pre
 
 ## Sign In
 
-![Opening the "Store" command in Raycast](<../.gitbook/assets/welcome (1).png>)
+![Opening the "Store" command in Raycast](../.gitbook/assets/welcome.png)
 
 You need to be signed in to use the following extension development commands.
 

diff --git a/docs/basics/prepare-an-extension-for-store.md b/docs/basics/prepare-an-extension-for-store.md
@@ -106,7 +106,7 @@ Here you will find requirements and guidelines that you'll need to follow in ord
 
 ### Screenshots
 
-![Screenshots will show in an extensions detail screen](<../.gitbook/assets/screenshots-example.png>)
+![Screenshots will show in an extensions detail screen](../.gitbook/assets/screenshots-example.png)
 
 * Screenshots are displayed in the metadata of an extension details screen, where users can click and browse through them to understand what your extension does in greater detail, before installing
 * You can add a maximum of six screenshots. We recommend adding at least three, so your extensions detail screen looks beautiful.
@@ -115,7 +115,7 @@ Here you will find requirements and guidelines that you'll need to follow in ord
 
 * To add a screenshot to your extension metadata, simply create a new folder called `metadata` in your extension folder. Then, add all your images to the `metadata` folder using the specifications below, following the Do’s and Dont’s. We’ll handle the rest.
 
-![Extension folder structure with a metadata folder and screenshots](<../.gitbook/assets/folder-structure.png>)
+![Extension folder structure with a metadata folder and screenshots](../.gitbook/assets/folder-structure.png)
 
 #### Specifications
 
@@ -153,38 +153,44 @@ You can use [Raycast Wallpapers](https://www.raycast.com/wallpapers) to make you
 
 * Make it easier for users to see exactly what notable changes have been made between each release of your extension with a `CHANGELOG.md` file in your extension metadata
   * To add Version History to your extension, add a `CHANGELOG.md` file to the root folder of your extension
-* See an extension files structure with [screenshots and a changelog file](prepare-an-extension-for-store.md#adding-screenshots)&#x20;
-* With each change, provide clear and descriptive information around the latest update, providing a title as a ## h2 header followed by ar date timestamp (YYYY-MM-DD)
+* See an extension files structure with [screenshots and a changelog file](prepare-an-extension-for-store.md#adding-screenshots)
+* With each change, provide clear and descriptive information around the latest update, providing a title as a h2 header followed by a date timestamp YYYY-MM-DD
+  * Make sure your change title is within square brackets
+  * Separate your title and date with a hyphen `-` and spaces either side of the hyphen
 * Below is an example of a changelog that follows the correct format
 
 ```markdown
 # Brew Changelog
 
-## Added a bunch of new feedback - (2022-01-17)
+## [Added a bunch of new feedback] - 2022-01-17
 - Improve reliability of `outdated` command
 - Add action to copy formula/cask name
 - Add cask name & tap to cask details
 - Add Toast action to cancel current action
 - Add Toast action to copy error log after failure
 
-## New Additions - (2022-12-13)
+## [New Additions] - 2022-12-13
 - Add greedy upgrade preference
 - Add `upgrade` command
 
-## Fixes & Bits - (2021-11-19)
+## [Fixes & Bits] - 2021-11-19
 - Improve discovery of brew prefix
 - Update Cask.installed correctly after installation
 - Fix installed state after uninstalling search result
 - Fix cache check after installing/uninstalling cask
 - Add uninstall action to outdated action panel
 
-## New Commands - (2021-11-04)
+## [New Commands] - 2021-11-04
 Add support for searching and managing casks
 
-## Added Brew - (2021-10-26)
+## [Added Brew] - 2021-10-26
 Initial version code
 ```
 
+{% hint style="info" %}
+You can use [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) to help you format your changelog correctly
+{% endhint %}
+
 ### Contributing to Existing Extensions vs Creating a New One
 
 * **When you should contribute to an existing extension instead of creating a new one**

diff --git a/docs/examples/doppler.md b/docs/examples/doppler.md
@@ -10,7 +10,7 @@ The full source code of the example can be found [here](https://github.com/rayca
 
 In this example we use a form to collect inputs from a user. To make it interesting, we use [Doppler](http://share.doppler.com) which is a service to make it easy to securely share sensitive information such as API keys or passwords.
 
-![Example: Safely share secrets with Doppler](../.gitbook/assets/example-doppler-share-secrets.png)
+![Example: Safely share secrets with Doppler](<../.gitbook/assets/example-doppler-share-secrets (1).png>)
 
 The extension has one command. The command is a simple form with a textfield for the secret, a dropdown for an expiration after views and a second dropdown for an alternate expiration after a maximum of days.