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.

Sign up for GitHub

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

Added documentation for new sub-route matching #177

Merged
merged 2 commits into from
May 24, 2024
Merged

Added documentation for new sub-route matching #177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c602bc
Added documentation for new sub-route matching
barankyle May 23, 2024
a2ee549
Merge branch 'main' into IR-2260-support-project-subroutes
armando-salazar May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/manual/02_concepts/01_projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@

### Routes
The `routes` property enables users to customise the various URL paths of their website utilizing dynamic loading of modules.
- Key: Represents the path _(with leading forward slash included)_ to the resource,
- Key: Represents the path _(with leading forward slash included)_ to the resource.
- If the route key ends with `/*`, then it will match all sub-paths of that route, but not the base route itself. e.g. `/test/*` will match `/test/test` and `/test/othertest`, but not `/test`

Check failure on line 94 in docs/manual/02_concepts/01_projects.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/manual/02_concepts/01_projects.md", "range": {"start": {"line": 94, "column": 117}}}, "severity": "ERROR"}
- If the route key ends with `*`, but the `*` is not preceded by a `/`, then it matches the base route and all sub-paths of that route. e.g. `/test*` will match `/test`, `/test/test`, and `/test/othertest`

Check failure on line 95 in docs/manual/02_concepts/01_projects.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "docs/manual/02_concepts/01_projects.md", "range": {"start": {"line": 95, "column": 49}}}, "severity": "ERROR"}

Check failure on line 95 in docs/manual/02_concepts/01_projects.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/manual/02_concepts/01_projects.md", "range": {"start": {"line": 95, "column": 139}}}, "severity": "ERROR"}
- If the key does not end with either of the above, then it will just match the exact route. e.g. `/test` will match `/test` but not `/test/test` nor `/test/othertest`

Check failure on line 96 in docs/manual/02_concepts/01_projects.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "docs/manual/02_concepts/01_projects.md", "range": {"start": {"line": 96, "column": 16}}}, "severity": "ERROR"}

Check warning on line 96 in docs/manual/02_concepts/01_projects.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Vocab] Verify your use of 'above' with the A-Z word list.

Raw Output:
{"message": "[Microsoft.Vocab] Verify your use of 'above' with the A-Z word list.", "location": {"path": "docs/manual/02_concepts/01_projects.md", "range": {"start": {"line": 96, "column": 48}}}, "severity": "INFO"}

Check failure on line 96 in docs/manual/02_concepts/01_projects.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/manual/02_concepts/01_projects.md", "range": {"start": {"line": 96, "column": 96}}}, "severity": "ERROR"}
- Value: Represents a react component object which gets wrapped with `React.lazy()`
- `props`: Passes options into the `react-dom-router.Route` component corresponding to the route.

Expand Down
Loading