Skip to content

Remove Release Summary section in README#3607

Merged
huchenlei merged 1 commit intomainfrom
bcl4
Apr 24, 2025
Merged

Remove Release Summary section in README#3607
huchenlei merged 1 commit intomainfrom
bcl4

Conversation

@benceruleanlu
Copy link
Member

@benceruleanlu benceruleanlu commented Apr 24, 2025

They should probably just read the releases page instead. And having a way to show new/breaking changes is incoming (?)

  • Outdated
  • Takes up a chunk of precious README space!
  • Bug where scrolling is prevented in vscode's inbuilt markdown preview feature, rubberbands back.

Update, remove, condense, push to after section for developers, or move to docs?

@benceruleanlu benceruleanlu requested a review from a team as a code owner April 24, 2025 19:46
@huchenlei huchenlei merged commit 3f85ff7 into main Apr 24, 2025
10 checks passed
@huchenlei huchenlei deleted the bcl4 branch April 24, 2025 20:34
@christian-byrne
Copy link
Contributor

Not so sure about this change. Most of the developer APIs are not in the docs yet so if they are removed from the README there is no documentation on them anywhere.

Can we revert until everything is in the docs and then replace with link to the docs sections?

Right now, there is low usage of frontend official developer APIs, and we definitely want to encourage their use as it makes things a lot easier long-term if extensions all use the prescribed interfaces only 👍

benceruleanlu added a commit that referenced this pull request May 7, 2025
christian-byrne pushed a commit that referenced this pull request May 20, 2025
Co-authored-by: Benjamin Lu <templu1107@proton.me>
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.

4 participants