Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Mark official stable API in docs #1004

Open
Danielku15 opened this issue Oct 9, 2022 · 0 comments
Open

Mark official stable API in docs #1004

Danielku15 opened this issue Oct 9, 2022 · 0 comments
Assignees
@Danielku15
Labels
area-core Related to some core parts of alphaTab area-documentation Related to documentation and sample code state-accepted This is a valid topic to work on. type-improvement 🚀

Comments

@Danielku15
Copy link
Member

AlphaTab has actually three level of APIs:

  1. The public official API and models where we want to follow SemVer
  2. Some low level APIs which are still public surface but can undergo breaking changes
  3. Only internal APIs.

As part of this issue we want to clearly flag and document which parts are level 1 and 2 to make our live easier during future releases.
@Danielku15 Danielku15 added type-improvement 🚀 state-accepted This is a valid topic to work on. area-documentation Related to documentation and sample code area-core Related to some core parts of alphaTab labels Oct 9, 2022
@Danielku15 Danielku15 self-assigned this Oct 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Danielku15 Danielku15

Labels
area-core Related to some core parts of alphaTab area-documentation Related to documentation and sample code state-accepted This is a valid topic to work on. type-improvement 🚀
Projects
alphaTab Roadmap
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Danielku15