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.

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

docs: improve breaking API changes docs #13099

Merged
merged 10 commits into from Jun 18, 2018

Conversation

Projects
None yet
4 participants
@ckerr
Member

ckerr commented May 29, 2018

Partial progress on electron/maintainers#189:

  • Add the breaking API changes to the main TOC for more visibility
  • Add a section showing the historic changes, such as 2.0's, so that app devs can have a one-stop reference for changes between versions
  • Rename the list as 'breaking API changes' to denote that a history will be listed as well as upcoming changes

Also, minor copyediting e.g. moving the API contract & FIXME comment text into their own section instead of embedding them the list of changes for a specific version

/cc @codebytere @zeke

@ckerr ckerr requested a review from electron/docs as a code owner May 29, 2018

@ckerr ckerr changed the title from Breaking changes to docs: improve breaking API changes docs May 29, 2018

@miniak

miniak approved these changes Jun 13, 2018

@zeke zeke merged commit 994f613 into master Jun 18, 2018

11 checks passed

WIP ready for review
Details
ci/circleci: electron-linux-arm Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-arm-test Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-arm64 Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-arm64-test Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-ia32 Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-x64 Your tests passed on CircleCI!
Details
ci/circleci: electron-mas-x64 Your tests passed on CircleCI!
Details
ci/circleci: electron-osx-x64 Your tests passed on CircleCI!
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@zeke zeke deleted the breaking-changes branch Jun 18, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment