Skip to content

refactor(getting-started): reorder steps and sidebar to reflect a more natural setup flow #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
babblebey merged 3 commits into from
Mar 24, 2026
Merged

refactor(getting-started): reorder steps and sidebar to reflect a more natural setup flow #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a0a566
docs: reformat getting started guide for semantic-release
babblebey Mar 23, 2026
c1c0ef0
docs: reorder CI configuration section in getting started guide
babblebey Mar 23, 2026
81c56fa
Merge branch 'realities/getting-started' of https://github.com/semant…
babblebey Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion astro.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,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" },
Expand Down
10 changes: 0 additions & 10 deletions src/content/docs/usage/getting-started.md
View file
Open in desktop

This file was deleted.

16 changes: 16 additions & 0 deletions src/content/docs/usage/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Getting started"
---

import { Steps } from "@astrojs/starlight/components";

In order to use **semantic-release** you must follow these steps:

<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

</Steps>
Loading