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

Proposal: tutorial creation workflow #7

Open
colinhicks opened this issue Oct 29, 2016 · 0 comments
Open

Proposal: tutorial creation workflow #7

colinhicks opened this issue Oct 29, 2016 · 0 comments

Comments

@colinhicks
Copy link
Owner

So that the tutorial rendering machinery can be maintained separately of tutorial content, the rendering machinery, including api documentation, will live in a dedicated GH repo, onyx-platform/onyx-blueprint. cf. #1

An "official" interactive tutorial will live as onyx-platform/onyx-tutorial. The browser experience will be served from GH pages, with available iterations per minor version of the Onyx runtime, starting with 0.9.x.

The official tutorial will be a community effort. I will submit a PR for its first draft, subject to the Onyx core team's approval.

Other, community-contributed tutorials will be highly encouraged. Start creating a custom tutorial as you would any ClojureScript application. Just require onyx-blueprint from Clojars (not yet though), set up your components and sections, then render your tutorial data via onyx-blueprint's api. You'll be able to use extension points to support custom tutorial ui components in addition to the default set.

Comments? Suggestions? Thanks!

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

No branches or pull requests

1 participant