Documentation Needs

[plwalters]

Docs Plan

A Web Developer

• What is Aurelia?
• Getting Started
• A Production Setup
• Creating Components
• Dependency Injection: Basics
• Templating: Basics
• Binding: Basics
• Router: Basics
• Animation: Basics
• App Configuration and Startup
• HTTP Services
• Binding: Value Converters
• Binding: Binding Behaviors
• Binding: Advanced Scenarios
• Templating: HTML Behaviors Introduction
• Templating: Custom Attributes
• Templating: Custom Elements
• Templating: Dynamic UI Composition
• Templating: View Resources
• Dependency Injection: Customization
• Cross Component Communication
• Router: Customization
• Securing Your App
• Structuring and Organizing Your App
• Unit Testing
• End-to-End Testing
• Bundling Your App for Deploy
• Summary: Conventions
• Summary: Lifecycles
• Cheat Sheet
• Glossary
• Errors
• Getting Help

Deep Dive

• How to Build the Skeleton from Scratch
• Binding Engine Architecture and Extensibility
• Templating Engine Architecture and Extensibility
• Router Architecture and Extensibility

New To Web Development

• What is Aurelia?
• Modern JavaScript and TypeScript
• Modern Tooling
• The Modern DOM
• Getting Started
• Next Steps For New Web Developers
• Cheat Sheet
• Getting Help

A Manager/CTO

• What is Aurelia?
• Aurelia's Technical Benefits
• Aurelia's Team and Community
• Aurelia's Business Advantage
• Onboarding Your Developers

An Architect

• What is Aurelia?
• Aurelia's Technical Benefits
• Aurelia's Architecture
• Building on Web Standards
• Team Workflow
• Composite Applications
• Aurelia's Business Advantage
• Onboarding Your Developers

A Contributor

• Contribution Guidelines
• Your First Pull Request
• Creating or Editing Documentation
• Translating Documentation
• Testing Documentation

A Plugin Author

• Plugins: What and Why?
• Creating a Plugin
• Publishing a Plugin
• Adding Your Plugin Docs to Aurelia's Docs

Integrating with Other Technologies

• Integrating with jQuery
• Integrating with Polymer
• Using 3rd Party Web Components
• Using Aurelia Components as Web Components
• Integrating with CSS Frameworks
• Using RequireJS and Bower
• Building a Cordova/PhoneGap App
• Building an Electron App
• Building an NWJS App
• Building a Windows Universal App

A Migrator

• Migrating From Durandal
• Migrating From Angular 1
• Migrating From Angular 2
• Migrating From Caliburn.Micro

[JeroenVinke]

I would like to see more about custom DOM events, and the differences between delegate and trigger and why bubble must be enabled when raising a CustomEvent.

[EisenbergEffect]

@JeroenVinke Good feedback. I believe that would be great content for "Binding: Basics"

[EisenbergEffect]

In the article "Templating: Dynamic UI Composition" we not only need to cover things like compose but we need to talk in depth about how to use the compiler directly to do more customized, dynamic UIs.

[EisenbergEffect]

In the article "Binding: Basics" we need to make sure to include information about when ref binding values become available. Previously they weren't available until the attached lifecycle callback, but as of the Beta they are now available earlier in the bind lifecycle callback.

[EisenbergEffect]

In the article "Templating: HTML Behaviors Introduction" we need to cover a bit about the general mechanism that underlies both Custom Elements and Custom Attributes. As part of that we need to talk about bindable. We should be sure to cover how that works when used as a field decorator and make sure to include examples of supplying options in that case.

[jdanyow]

binding basics: delegate vs trigger
cc @JeroenVinke

[EisenbergEffect]

We should include your SO answer direction in "Binding: Basics"

[adriatic]

• Under Web Developer section
  Integrating Aurelia Help component with third party (Aurelia of course) applications
• Under Integrating with Other Technologies Identity Management (see Auth0-Angular as an example)

[EisenbergEffect]

For "Binding: Basics" be sure to demonstrate how contextual properties work, particularly in the case of call bindings.

[EisenbergEffect]

@adriatic Are you referring to using our docs technology to document 3rd party Aurelia plugins and us providing docs on how to do that?

[adriatic]

Are you referring to using our docs technology to ...

Yes - as we are about to finish the document set for http://aurelia-ui-toolkits.github.io/demo-kendo first preview and would love not to continue rolling our own