From b6a4d39c51a8ce3b284222efcb102b35f6d331b4 Mon Sep 17 00:00:00 2001 From: daimond113 <72147841+daimond113@users.noreply.github.com> Date: Sun, 24 Nov 2024 17:42:28 +0100 Subject: [PATCH] docs: update docs to use globs in includes --- docs/src/content/docs/guides/publishing.mdx | 5 ++--- docs/src/content/docs/guides/roblox.mdx | 2 +- docs/src/content/docs/guides/self-hosting-registries.mdx | 4 ++-- docs/src/content/docs/reference/manifest.mdx | 6 +++--- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/src/content/docs/guides/publishing.mdx b/docs/src/content/docs/guides/publishing.mdx index 309ff5d..9bdc6d4 100644 --- a/docs/src/content/docs/guides/publishing.mdx +++ b/docs/src/content/docs/guides/publishing.mdx @@ -12,15 +12,14 @@ Before you can publish a package, you must configure the required fields in your ### `includes` -The `includes` field is a list of files and directories that should be included -in the package. +The `includes` field is a list of globs that should be included in the package. ```toml includes = [ "pesde.toml", "README.md", "LICENSE", - "init.luau", + "src/**/*.luau", ] ``` diff --git a/docs/src/content/docs/guides/roblox.mdx b/docs/src/content/docs/guides/roblox.mdx index d9723e3..44386f4 100644 --- a/docs/src/content/docs/guides/roblox.mdx +++ b/docs/src/content/docs/guides/roblox.mdx @@ -99,7 +99,7 @@ includes = [ "pesde.toml", "LICENSE", "README.md", - "src", + "src/**/*.luau", ] [target] diff --git a/docs/src/content/docs/guides/self-hosting-registries.mdx b/docs/src/content/docs/guides/self-hosting-registries.mdx index cc20ac9..c856d4d 100644 --- a/docs/src/content/docs/guides/self-hosting-registries.mdx +++ b/docs/src/content/docs/guides/self-hosting-registries.mdx @@ -88,8 +88,8 @@ has access to the index repository. We recommend using a separate account for this purpose. diff --git a/docs/src/content/docs/reference/manifest.mdx b/docs/src/content/docs/reference/manifest.mdx index 3bc7d89..8851ab0 100644 --- a/docs/src/content/docs/reference/manifest.mdx +++ b/docs/src/content/docs/reference/manifest.mdx @@ -71,8 +71,8 @@ package cannot be published to the registry. ### `includes` -List of top-level files and directories to include in the package when -publishing. Files not listed here will not be published. +List of globs to include in the package when publishing. Files and directories +not listed here will not be published. ```toml includes = [ @@ -80,7 +80,7 @@ includes = [ "README.md", "LICENSE", "init.luau", - "docs", + "docs/**/*.md", ] ```