From 5a8907c33584f7a9f19013d3d89f2e67fd5db9a9 Mon Sep 17 00:00:00 2001
From: daimond113 <72147841+daimond113@users.noreply.github.com>
Date: Sun, 31 Mar 2024 14:13:38 +0200
Subject: [PATCH] docs(website): document exports field of manifest

---
 website/src/routes/docs/+page.svelte | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/website/src/routes/docs/+page.svelte b/website/src/routes/docs/+page.svelte
index b971294..1972191 100644
--- a/website/src/routes/docs/+page.svelte
+++ b/website/src/routes/docs/+page.svelte
@@ -146,6 +146,10 @@ pesde patch-commit DIRECTORY"
 			ignored.</Note
 		>
 		<Codeblock code="pesde publish" />
+		<p>
+			Please look at the <a href="#cheatsheet">manifest format cheat sheet</a> for more information about
+			the pesde.yaml file before publishing.
+		</p>
 	</section>
 
 	<section>
@@ -158,7 +162,7 @@ pesde patch-commit DIRECTORY"
 	</section>
 
 	<section>
-		<h2>Manifest format cheat sheet</h2>
+		<h2 id="cheatsheet">Manifest format cheat sheet</h2>
 		<p>
 			Here is a cheat sheet for the manifest format. This is the format of the pesde.yaml file. The
 			`name` and `version` fields are required. All other fields are optional.
@@ -185,7 +189,7 @@ pesde patch-commit DIRECTORY"
 					lang="yaml"
 					code="name: STANDARD_PACKAGE_NAME
 version: VERSION_REQ
-# OPTIONAL (name in the `indices` field)
+# OPTIONAL (name in the `indices` field) - defaults to `default`
 index: STRING"
 				/>
 			</li>
@@ -234,6 +238,14 @@ overrides:
 dependencies: DEPENDENCY_SPECIFIER[]
 peer_dependencies: DEPENDENCY_SPECIFIER[]"
 		/>
+		<p>The exports field is used to specify the paths of the package's exports:</p>
+		<ul>
+			<li>
+				The `lib` field is a path to the file which will become the ModuleScript of the package.
+				This is only used for reading the types of the package.
+			</li>
+			<li>The `bin` field is a path to the file which will be ran with the `run` command.</li>
+		</ul>
 		<p>
 			If the realm field is not specified, it will default to `shared`. If it is another value, and
 			the package is to be installed in a different realm, pesde will error.