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

More in-app documentation #3

Open
pckerneis opened this issue Oct 23, 2018 · 1 comment
Open

More in-app documentation #3

pckerneis opened this issue Oct 23, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@pckerneis
Copy link
Owner

I'd like more in-app documentation in various forms.

  • The only one implemented today is the tips for Message elements (a popup-up filtered list of methods accessible is shown when the message's editor is used).
  • There should be a description of WebAudio elements such as nodes, contexts, buffer... It could be a tip window in the LibraryPanel or maybe a footer bar (but it'd be a small space for potentially long texts).
  • There should be a documentation panel. It can be based on JUCE's WebBrowserComponent to show HTML doc. Quick access to topics should be possible (something like "Show in documentation" in graph elements popup menu).
  • Auto-completion/validation in the code editors is too ambitious for now. It'd require to actually interpret the JS code.
@pckerneis pckerneis added the enhancement New feature or request label Oct 23, 2018
@pckerneis
Copy link
Owner Author

pckerneis commented Oct 23, 2018

The documentation for WebAudio objects and methods can be adapted from the w3c specs and Mozilla's documentation. The documentation should be clear about what is natively present in WebAudio and the app-specific layer of graph elements (messages, dynamic routes, scripts, DecodableAudio,...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant