feat: implement new semantic-release documentation site by babblebey · Pull Request #2 · semantic-release/docs

babblebey · 2026-03-09T05:44:09Z

This pull request introduces a major reorganization and modernization of the documentation site, shifting from gitbook to a more non-service tied and custom framework by implementing @withastro and integrating @astrojs/starlight.

Other Changes

Introduced a lint github workflow for code quality

Screencast/Screenshot

screen-capture.28.webm

- Added package.json for project dependencies and scripts - Included tsconfig.json for TypeScript configuration

…ssues - Documented permission errors when publishing packages. - Explained the impact of squashed commits on semantic-release. - Provided guidance on resolving `reference already exists` errors when pushing tags. - Added instructions for recovering from lost releases after `git push --force`. feat: create CI configuration guide for semantic-release - Outlined the importance of running semantic-release after all tests pass. - Listed CI services that support this configuration. - Explained authentication requirements for pushing to remote repositories. feat: introduce comprehensive configuration documentation - Detailed the configuration options available for semantic-release. - Explained how to set up configuration files and CLI arguments. - Provided examples for configuring branches, repository URLs, and plugins. feat: establish getting started guide for semantic-release - Created a step-by-step guide for installing and configuring semantic-release. feat: outline installation methods for semantic-release - Recommended global installation via npx for CI environments. - Discussed the implications of local installation and dependency management. feat: document plugins and their configuration in semantic-release - Explained the role of plugins in the release process. - Listed default plugins and how to install additional ones. - Provided examples of plugin declaration and execution order. feat: introduce shareable configurations for semantic-release - Explained the concept of shareable configurations and how to use them. feat: detail release workflow configuration for semantic-release - Described the management of complex release workflows with multiple branches. - Explained branch types and their properties for effective release management.

…ved navigation order

…json

- Refactor the highlights section in intro.md for better readability. - Update CI configurations index.md to improve formatting. - Enhance git authentication SSH keys documentation for clarity. - Standardize formatting in git-hosted services index.md. - Improve distribution channels recipe formatting for consistency. - Refine release workflow recipes for better structure. - Update FAQ.md for improved clarity and consistency. - Enhance resources.md with better formatting for video and article lists. - Improve CI configuration documentation for better readability. - Standardize configuration documentation for semantic-release options. - Update installation.md for clearer instructions on global installation. - Refactor plugins.md for better readability and structure. - Enhance workflow-configuration.md for improved clarity and consistency.

…ects

…ry information

…rity

…ting

vercel · 2026-03-09T05:44:13Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
semantic-release-docs	Ready	Preview, Comment	Mar 14, 2026 6:19pm

travi · 2026-03-13T19:28:50Z

Introduced a new astro.config.mjs file

Added a .prettierrc.mjs file

initial suggestion before diving deeper: lets avoid .mjs extensions. since the project is ESM, the "m" can be dropped

travi

this all looks good to me.

i havent tried to start it locally to see it rendered. is that the simplest way to see how things look? looking forward to getting hosting setup so we could have a PR preview deploy to take a look at

the one question i have is whether the embedded styles and js could be extracted to separate files or not. i'm not up to speed on astro or tailwind, so you might tell me that it is common convention in those cases, but i still prefer separate files if that does conflict with things

travi · 2026-03-13T21:43:11Z

interesting update to the logo :D

We already are deployed actually... currently sharing the @hearts vercel account pending the while we get a pro account from Vercel.... and the preview for this particular PR is https://semantic-release-docs-git-feat-new-hearts.vercel.app/

Preview, Comment

Link's in the Preview text on the vercel's PR comment

Link's in the Preview text on the vercel's PR comment

🤦🏼 totally overlooked that comment, haha. thanks for the clarity

i like it 👍🏼

…d is set to false in index.mdx

…ed sections

…ments

…..slug].png.ts

…rieval

babblebey · 2026-03-14T19:08:17Z

i have is whether the embedded styles and js could be extracted to separate files or not. i'm not up to speed on astro or tailwind

The embedded style/js-script is kinda convention for astro, think it like a way of containing a needed interactivity within a component if needed for hydration.

More like how interactivity is contained in a .jsx file that's the how to add interactivity to .astro..

YES of-course you can externalise and import but while you can import .../style.css in the frontmatter for css to an astro component.... it will have be within the <script>import ../script.js</script> or <script src="../scripts.js"></script> tag at the bottom of the astro file still if you're import external js interaction to an astro component if you want it hydrated.

babblebey added 30 commits March 7, 2026 16:12

chore: initialize project with package.json and tsconfig.json

cb2f780

- Added package.json for project dependencies and scripts - Included tsconfig.json for TypeScript configuration

feat: add content configuration for documentation collections

5f1877f

feat: configure logos

b543380

feat: add theme-aware favicon SVG for improved branding

a689c52

feat: add IDE-specific files to .gitignore

8c26961

feat: update sidebar configuration with explicit item slugs for impro…

ffc4b04

…ved navigation order

feat: add introduction section and associated image to documentation

c698d54

feat: add Prettier for code formatting and update scripts in package.…

14f837c

…json

feat: initialise main landing page

94879c1

feat: integrate Tailwind CSS and update package dependencies

abe7ad0

feat: enhance global styles with theme variables and hero section eff…

0d6d03c

…ects

fix: adjust formatting for better readability in index.mdx

e33f72c

feat: update asset paths to use tilde notation for consistency

94d4c22

feat: add edit link configuration for documentation

5bd54e7

feat: add site configuration to Astro config

a55cca4

feat: set editUrl to false in index.mdx

2b2b843

fix: correct formatting of editLink baseUrl in astro.config.mjs

54f3299

fix: correct capitalization of "Get Started" text in index.mdx

f9bf18d

feat: add Hero component override and integrate into Astro config

80dcb36

feat: add Header component override and implement its structure

8498fc3

feat: update button styles for consistency and enhance modal appearance

2bd7d65

feat: enhance Hero component with 3D tilt effect and improved styling

94231a6

feat: update package.json to include bugs, contributors, and reposito…

cfccd60

…ry information

feat: add accent and gray color palettes to global styles

bab2200

Refactor code structure for improved readability and maintainability

3177140

feat: add max-width utility to sidebar container for improved layout

570c8d0

feat: remove outdated documentation sections and summary file for cla…

190a04e

…rity

feat: add Prettier configuration and Astro plugin for improved format…

d6fda26

…ting

vercel Bot deployed to Preview March 9, 2026 05:44 View deployment

babblebey changed the title ~~feat: implement new semantic-release documentation~~ feat: implement new semantic-release documentation site Mar 9, 2026

babblebey requested a review from travi March 9, 2026 05:49

feat: enhance sidebar layout and improve modal styling in global CSS

c84a193

vercel Bot deployed to Preview March 13, 2026 19:40 View deployment

refactor: remove .mjs style Astro configuration and Prettier setup

5f04bcc

vercel Bot deployed to Preview March 13, 2026 19:54 View deployment

travi approved these changes Mar 13, 2026

View reviewed changes

babblebey added 5 commits March 14, 2026 16:19

fix: add missing newline at end of global CSS file and ensure pagefin…

4e589ba

…d is set to false in index.mdx

feat: update README to enhance clarity and structure, removing outdat…

d43d04e

…ed sections

feat: update site URL configuration to support Vercel preview environ…

21e6cbf

…ments

feat(open-graph): implement dynamic OG image generation for improved SEO

02c20f1

fix: update Open Graph image URL to use correct origin for improved SEO

16529e8

vercel Bot deployed to Preview March 14, 2026 16:24 View deployment

babblebey added 5 commits March 14, 2026 18:02

feat: add responsive styles for sidebar layout in global CSS

93df964

style: format code for improved readability in astro.config.js and [.…

f44878f

…..slug].png.ts

refactor: move og route from ts to js

77c869e

feat: add rounded styles to pagefind search input for consistency

0ee4320

feat(workflow): add linting workflow for code quality checks

169cba7

vercel Bot had a problem deploying to Preview March 14, 2026 17:55 Failure

feat: import getCollection from astro:content for dynamic content ret…

5a9f452

…rieval

vercel Bot deployed to Preview March 14, 2026 18:00 View deployment

babblebey marked this pull request as ready for review March 14, 2026 18:15

chore: remove unused .gitbook asset

edae4ef

vercel Bot deployed to Preview March 14, 2026 18:19 View deployment

babblebey merged commit 7e86246 into main Mar 14, 2026
4 checks passed

babblebey deleted the feat/new branch March 14, 2026 19:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement new semantic-release documentation site#2

feat: implement new semantic-release documentation site#2
babblebey merged 45 commits into
mainfrom
feat/new

babblebey commented Mar 9, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Mar 9, 2026 •

edited

Loading

Uh oh!

travi commented Mar 13, 2026

Uh oh!

travi left a comment

Uh oh!

travi Mar 13, 2026

Uh oh!

babblebey Mar 13, 2026 •

edited

Loading

Uh oh!

travi Mar 13, 2026

Uh oh!

travi Mar 13, 2026

Uh oh!

babblebey commented Mar 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

babblebey commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other Changes

Screencast/Screenshot

Uh oh!

vercel Bot commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

travi commented Mar 13, 2026

Uh oh!

travi left a comment

Choose a reason for hiding this comment

Uh oh!

travi Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

babblebey Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

travi Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

travi Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

babblebey commented Mar 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

babblebey commented Mar 9, 2026 •

edited

Loading

vercel Bot commented Mar 9, 2026 •

edited

Loading

babblebey Mar 13, 2026 •

edited

Loading