From c7f9c8e03c88bfaa36c0dc320d79aa11a21646c6 Mon Sep 17 00:00:00 2001 From: Erica Marigold Date: Sun, 23 Feb 2025 11:51:25 +0000 Subject: [PATCH] fix(lune): write docs to `docs/intro.md` instead --- .lune/docsgen/init.luau | 2 +- CHANGELOG.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.lune/docsgen/init.luau b/.lune/docsgen/init.luau index 1c2078e..3b64c3f 100644 --- a/.lune/docsgen/init.luau +++ b/.lune/docsgen/init.luau @@ -29,6 +29,6 @@ local function extract(input: string): (number, { moonwave.Item }?) end local code, items = extract("lib/init.luau") -writeMarkdown("./docs/index.md", items :: { moonwave.Item }) +writeMarkdown("./docs/intro.md", items :: { moonwave.Item }) process.exit(code) diff --git a/CHANGELOG.md b/CHANGELOG.md index dba2425..c441093 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] -## [0.1.2] - 2025-02-23 +## [0.1.3] - 2025-02-23 +This is a hotfix release to fix documentation not being displayed properly on the pesde package page. + +### Fixed +- Markdown doc file not being named correctly (rename docs/index.md->docs/intro.md) + +## [0.1.2] - 2025-02-23 [YANKED] This update brings documentation and some bug fixes! Your IDE should now display information such as usage and best practices for this library when you hover over any of its exported items. The docs are also available on the web in the markdown format, which can be found on [the pesde package page](https://pesde.dev/packages/0x5eal/unzip/0.1.2/luau/docs/intro). ### Added