From 2a0a566953db7366318f5354d9c4ba7c3522c5c5 Mon Sep 17 00:00:00 2001 From: babblebey Date: Mon, 23 Mar 2026 18:30:25 +0100 Subject: [PATCH 1/2] docs: reformat getting started guide for semantic-release --- src/content/docs/usage/getting-started.md | 10 ---------- src/content/docs/usage/getting-started.mdx | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 10 deletions(-) delete mode 100644 src/content/docs/usage/getting-started.md create mode 100644 src/content/docs/usage/getting-started.mdx diff --git a/src/content/docs/usage/getting-started.md b/src/content/docs/usage/getting-started.md deleted file mode 100644 index 0b9b97a..0000000 --- a/src/content/docs/usage/getting-started.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Getting started" ---- - -In order to use **semantic-release** you must follow these steps: - -1. [Install](installation.md#installation) **semantic-release** in your project -2. Configure your Continuous Integration service to [run **semantic-release**](ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded) -3. Configure your Git repository and package manager repository [authentication](ci-configuration.md#authentication) in your Continuous Integration service -4. Configure **semantic-release** [options and plugins](configuration.md#configuration) diff --git a/src/content/docs/usage/getting-started.mdx b/src/content/docs/usage/getting-started.mdx new file mode 100644 index 0000000..c660a02 --- /dev/null +++ b/src/content/docs/usage/getting-started.mdx @@ -0,0 +1,16 @@ +--- +title: "Getting started" +--- + +import { Steps } from "@astrojs/starlight/components"; + +In order to use **semantic-release** you must follow these steps: + + + +1. [Install](/usage/installation) **semantic-release** in your project +2. Configure **semantic-release** [options and plugins](/usage/configuration) +3. Configure your Continuous Integration service to [run **semantic-release**](/usage/ci-configuration#run-semantic-release-only-after-all-tests-succeeded) +4. Configure your Git repository and package manager repository [authentication](/usage/ci-configuration#authentication) in your Continuous Integration service + + From c1c0ef0776b3ac62531f989b8414cddb65ed47a4 Mon Sep 17 00:00:00 2001 From: babblebey Date: Mon, 23 Mar 2026 18:35:16 +0100 Subject: [PATCH 2/2] docs: reorder CI configuration section in getting started guide --- astro.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/astro.config.js b/astro.config.js index d9d02be..527af9d 100644 --- a/astro.config.js +++ b/astro.config.js @@ -47,8 +47,8 @@ export default defineConfig({ items: [ { slug: "usage/getting-started" }, { slug: "usage/installation" }, - { slug: "usage/ci-configuration" }, { slug: "usage/configuration" }, + { slug: "usage/ci-configuration" }, { slug: "usage/plugins" }, { slug: "usage/workflow-configuration" }, { slug: "usage/shareable-configurations" },