aurelia / aurelia/documentation
Documentation Needs
- Dominant language
- No language data
- Stars
- 104
- Forks
- 108
- PR merge metrics
- No merged PRs in 30d
Description
# Docs Plan
## A Web Developer
- [x] What is Aurelia?
- [x] Getting Started
- [x] A Production Setup
- [x] Creating Components
- [x] Dependency Injection: Basics
- [x] Templating: Basics
- [x] Binding: Basics
- [x] Router: Basics
- [x] Animation: Basics
- [x] App Configuration and Startup
- [x] HTTP Services
- [x] Binding: Value Converters
- [x] Binding: Binding Behaviors
- [ ] Binding: Advanced Scenarios
- [x] Templating: HTML Behaviors Introduction
- [x] Templating: Custom Attributes
- [x] Templating: Custom Elements
- [ ] Templating: Dynamic UI Composition
- [ ] Templating: View Resources
- [ ] Dependency Injection: Customization
- [ ] Cross Component Communication
- [ ] Router: Customization
- [x] Securing Your App
- [ ] Structuring and Organizing Your App
- [x] Unit Testing
- [x] End-to-End Testing
- [x] Bundling Your App for Deploy
- [ ] Summary: Conventions
- [ ] Summary: Lifecycles
- [x] Cheat Sheet
- [ ] Glossary
- [ ] Errors
- [x] 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
- [x] What is Aurelia?
- [ ] Modern JavaScript and TypeScript
- [ ] Modern Tooling
- [ ] The Modern DOM
- [x] Getting Started
- [ ] Next Steps For New Web Developers
- [x] Cheat Sheet
- [x] Getting Help
## A Manager/CTO
- [x] What is Aurelia?
- [x] Aurelia's Technical Benefits
- [ ] Aurelia's Team and Community
- [x] Aurelia's Business Advantage
- [ ] Onboarding Your Developers
## An Architect
- [x] What is Aurelia?
- [x] Aurelia's Technical Benefits
- [ ] Aurelia's Architecture
- [ ] Building on Web Standards
- [ ] Team Workflow
- [ ] Composite Applications
- [x] 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
- [x] 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
Contributor guide
Research direction
Start by reviewing the unchecked sections in the Docs Plan, especially the contributor, web-development, architecture, integration, and migration topics. Define a focused documentation scope before starting; completion would require updating the checklist only when the selected topic is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100