Skip to content

Comments

clarify Astro's public API in semantic versioning docs#13293

Closed
OliverSpeir wants to merge 1 commit intomainfrom
docs/semver-public-api
Closed

clarify Astro's public API in semantic versioning docs#13293
OliverSpeir wants to merge 1 commit intomainfrom
docs/semver-public-api

Conversation

@OliverSpeir
Copy link
Contributor

@OliverSpeir OliverSpeir commented Feb 22, 2026

Adds a sentence to the semantic versioning section clarifying that Astro's public API is defined by the features documented on the official Astro documentation.

For this system to work, you first need to declare a public API.

https://semver.org

@netlify
Copy link

netlify bot commented Feb 22, 2026

Deploy Preview for astro-docs-2 failed. Why did it fail? →

Name Link
🔨 Latest commit 8ca0408
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/699ac200f080e0000890dd85

@astrobot-houston
Copy link
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/upgrade-astro.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@sarah11918
Copy link
Member

Hi Oliver! We're in a v5 docs freeze right now, so we're not updating English docs except emergency fixes like broken links. (I'm not sure if you filed this in such a way that you saw our PR template, but it clearly states there that we are not updating English docs right now.)

Also, I'm not sure this statement is necessary? Reading the original text, I don't believe the intention is that you need to publicly declare "this is a public API"? I think it means that their system depends on there being a public API in the first place, which as they say could be described through documentation (which we do).

So, I'm going to close this PR, but maybe you could open a discussion to see what others think about that statement and get some consensus? (Again, I don't read it as a formal declaration being needed at all, but obviously you did. So I guess we'll need more eyes!) Then, if needed, something can be done after we've released v6.

@sarah11918 sarah11918 closed this Feb 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants