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.

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

Improvement: Move Reference docs fully into TS Doc and generate them #89

Open
Danielku15 opened this issue May 14, 2024 · 0 comments
Open
Assignees

Comments

@Danielku15
Copy link
Member

Currently the reference docs for API and Settings are maintained manually.
We should auto-generate those pages from the codebase.

We should parse the alphaTab.d.ts and its contained TS Doc and create documentation based on it. We might need some more custom @tags to have samples, target specifics, internal APIs etc. separated correctly.

This way we can focus more on writing actual feature guides than maintaining these pages.

@Danielku15 Danielku15 self-assigned this May 14, 2024
@Danielku15 Danielku15 moved this to Candidate in alphaTab 1.4-1.x May 14, 2024
@Danielku15 Danielku15 moved this from Candidate to Todo in alphaTab 1.4-1.x May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Status: No status
Development

No branches or pull requests

1 participant