Skip to content

docs: update changes page#18026

Merged
patak-cat merged 3 commits intov6/environment-apifrom
docs-changes-page
Sep 4, 2024
Merged

docs: update changes page#18026
patak-cat merged 3 commits intov6/environment-apifrom
docs-changes-page

Conversation

@bluwy
Copy link
Copy Markdown
Member

@bluwy bluwy commented Sep 4, 2024

Description

related #18011

I think I got carried away updating the changes page, but feel free to point out if you don't agree with something. Or if this change is not worth it.

  • Renamed "Major changes" -> "Breaking changes" (I think major changes are always breaking changes, so better to use a familiar term?)
  • Renamed the sections to "Planned", "Considering", "Past"
    • "Planned": We've decided this is a breaking change we want to do in the future
    • "Considering": Still considering if we want to do this breaking change
    • "Past": Past breaking changes, or things we have decided not to do
  • Added a future option docs in the shared-options.md page.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Comment thread docs/.vitepress/config.ts
'/changes/': [
{
text: 'Major Changes',
text: 'Breaking Changes',
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One reason to call it "Major Changes" was to avoid the need to force us to document every Breaking Change in the same way. It is kind of "Major Breaking Changes". But probably having breaking here is more clear and we don't need to feel the pressure to have small breaking changes guides.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true, maybe we can mention not all breaking changes are listed here? Or do you think we should still stick with major changes?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge and then we can continue refining this later. I think we should at least mention that only major breaking changes will be documented in this way

@patak-cat patak-cat merged commit 9b8c2af into v6/environment-api Sep 4, 2024
@patak-cat patak-cat deleted the docs-changes-page branch September 4, 2024 08:48
Copy link
Copy Markdown

@ali963git ali963git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4

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