aurelia / aurelia/documentation

Troubleshooting pages

Open
#448 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
No language data
Stars
104
Forks
108
PR merge metrics
No merged PRs in 30d

Description

* **I'm submitting a feature request**

So you've finished reading the documentation and ready to get cracking on your Aurelia app,
but when you get started your making stupid newbie mistakes. Where do you get the answers to those questions?

Currently there isn't anything that lists problems, how to troubleshoot and then resolve them.

* **What is the expected behavior?**

The page `Guides > Troubleshooting` should exist listing common problems.

If possible, tooling support should be built to make the Troubleshooting page obsolete. That's possibly eslint or additional Aurelia development time behaviours.

Is there a preference?
eslint would give you IDE warnings before you try running your code.
Aurelia development behaviour would give you in app feedback.

If possible this should work for v1 and vNext.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing Guides structure and the requested `Guides > Troubleshooting` page location. Define the initial set of common problems and their resolutions, then clarify whether ESLint or Aurelia development behavior is in scope and whether the result must cover both v1 and vNext.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.