aurelia / aurelia/documentation

Routing=>Router Configuration=>moduleId is not described

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

Description

`RouteConfig.moduleId` is not described in Routing=>Router Configuration=>Basic Configuration

In the API, for the `RouteConfig` interface it says:

"The moduleId of the view model that should be activated for this route", but that still begs the question, what is a moduleId? Then, what are the rules for resolving it to a view? What if there _is_ no view model, only a view?

Since moduleId is a required value, it could be quite useful to document it in this section, with the other important RouteConfig parameters that are already documented there.

Contributor guide

Open the contributing guide

Research direction

Start with Routing > Router Configuration > Basic Configuration and the RouteConfig interface description. Determine how moduleId is resolved to a view and how routes behave when there is no view model; done means this required parameter is clearly documented alongside the other RouteConfig parameters.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.