feat: add timed docs to top nav #570
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MitanOmar
force-pushed
the
Add-Timed-Docs-To-Top-Nav
branch
2 times, most recently
from
2f4a26f to
f15114a
Compare
MitanOmar
force-pushed
the
Add-Timed-Docs-To-Top-Nav
branch
from
f15114a to
13f9bdc
Compare
c0rydoras
requested changes
Jan 9, 2025
frontend/app/services/docs.js
Outdated
Comment on lines
11
to
31
| get getDocsURL() { | ||
| const docsUrlMatch = { | ||
| // timedUrl: DocsUrl | ||
| "/attendances": "tracking/attendances", | ||
| "/reports": "tracking/timesheet", | ||
| "/analysis": "analysis", | ||
| "/statistics": "statistics", | ||
| "/projects": "projects", | ||
| "/users": "users", | ||
| "/": "tracking/activities", | ||
| }; | ||
|
|
||
| for (const timedUrl of Object.keys(docsUrlMatch)) { | ||
| if (this.router.currentURL?.startsWith(timedUrl)) { | ||
| return docsUrlMatch[timedUrl]; | ||
| } | ||
| } | ||
| return ""; | ||
| } | ||
| } |
There was a problem hiding this comment.
you could use the current route instead of the current url
frontend/app/services/docs.js
Outdated
| } | ||
|
|
||
| get getDocsURL() { | ||
| const docsUrlMatch = { |
There was a problem hiding this comment.
this could be a constant
// filename.js
const ROUTE_DOCS_MAP = {
...
}
frontend/app/services/docs.js
Outdated
| timedDocsURL = "https://timed.dev/docs/"; | ||
| @service router; | ||
|
|
||
| get getDocsEndpoint() { |
There was a problem hiding this comment.
you could just call it docsEndpoint
MitanOmar
force-pushed
the
Add-Timed-Docs-To-Top-Nav
branch
from
13f9bdc to
a4385aa
Compare
MitanOmar
force-pushed
the
Add-Timed-Docs-To-Top-Nav
branch
from
a4385aa to
18c6207
Compare
c0rydoras
requested changes
Jan 20, 2025
Comment on lines
+23
to
+31
| get getDocsURL() { | ||
| for (const timedRouterName of Object.keys(this.docsUrlMatch)) { | ||
| if (this.router.currentRouteName === timedRouterName) { | ||
| return this.docsUrlMatch[timedRouterName]; | ||
| } | ||
| } | ||
| return ""; | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| get getDocsURL() { | |
| for (const timedRouterName of Object.keys(this.docsUrlMatch)) { | |
| if (this.router.currentRouteName === timedRouterName) { | |
| return this.docsUrlMatch[timedRouterName]; | |
| } | |
| } | |
| return ""; | |
| } | |
| } | |
| get getDocsURL() { | |
| return DOCS_URL_MAP[this.router.currentRouteName] | |
| } | |
| } |
Comment on lines
+2
to
+17
|
|
||
| export default class DocsService extends Service { | ||
| timedDocsURL = "https://timed.dev/docs/"; | ||
| @service router; | ||
|
|
||
| docsUrlMatch = { | ||
| // index.name: DocsUrl | ||
| "index.attendances": "tracking/attendances", | ||
| "index.reports": "tracking/timesheet", | ||
| "analysis.index": "analysis", | ||
| statistics: "statistics", | ||
| projects: "projects", | ||
| "users.index": "users", | ||
| "users.edit.index": "users", | ||
| "index.activities.index": "tracking/activities", | ||
| }; |
There was a problem hiding this comment.
more of a nitpick but personally i'd prefer this over having it in the service
Suggested change
| export default class DocsService extends Service { | |
| timedDocsURL = "https://timed.dev/docs/"; | |
| @service router; | |
| docsUrlMatch = { | |
| // index.name: DocsUrl | |
| "index.attendances": "tracking/attendances", | |
| "index.reports": "tracking/timesheet", | |
| "analysis.index": "analysis", | |
| statistics: "statistics", | |
| projects: "projects", | |
| "users.index": "users", | |
| "users.edit.index": "users", | |
| "index.activities.index": "tracking/activities", | |
| }; | |
| const DOCS_URL_MAP = { | |
| // index.name: DocsUrl | |
| "index.attendances": "tracking/attendances", | |
| "index.reports": "tracking/timesheet", | |
| "analysis.index": "analysis", | |
| statistics: "statistics", | |
| projects: "projects", | |
| "users.index": "users", | |
| "users.edit.index": "users", | |
| "index.activities.index": "tracking/activities", | |
| }; | |
| export default class DocsService extends Service { | |
| timedDocsURL = "https://timed.dev/docs/"; | |
| @service router; | |
Comment on lines
+7
to
+12
| // TODO: Replace this with your real tests. | ||
| test("it exists", function (assert) { | ||
| const service = this.owner.lookup("service:docs"); | ||
| assert.ok(service); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
some real tests would be nice 😉
There was a problem hiding this comment.
This is unit test, and the real functionality of this service depend on routing change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.