feat: add timed docs to top nav

Author: MitanOmar

frontend/app/components/topnav.hbs

@@ -88,6 +88,17 @@
       </Topnav::List>
       <Topnav::List class="md:ml-auto md:border-t-0">
         <ReportReviewWarning @class="max-md:hidden" />
+        <Topnav::ListItem>
+          <Topnav::LinkTo
+            @onClick={{fn (mut this.expand) false}}
+            title="Timed Documentation Of This Page"
+            href={{this.docs.docsEndpoint}}
+            target="_blank"
+          >
+            <FaIcon @icon="book" />
+            Docs
+          </Topnav::LinkTo>
+        </Topnav::ListItem>
         <Topnav::ListItem>
           <Topnav::LinkTo
             @onClick={{fn (mut this.expand) false}}

frontend/app/components/topnav.js

@@ -7,6 +7,8 @@ export default class Topnav extends Component {
 
   @service media;
 
+  @service docs;
+
   @tracked expand = false;
 
   get navMobile() {

frontend/app/services/docs.js

@@ -0,0 +1,32 @@
+import Service, { service } from "@ember/service";
+
+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",
+  };
+
+  get docsEndpoint() {
+    console.log(this.router.currentRouteName);
+    return this.timedDocsURL + this.getDocsURL;
+  }
+
+  get getDocsURL() {
+    for (const timedRouterName of Object.keys(this.docsUrlMatch)) {
+      if (this.router.currentRouteName === timedRouterName) {
+        return this.docsUrlMatch[timedRouterName];
+      }
+    }
+    return "";
+  }
+}

frontend/tests/acceptance/external-employee-test.js

@@ -51,7 +51,7 @@ module("Acceptance | external employee", function (hooks) {
   test("can only view tracking in top navigation", async function (assert) {
     await visit("/");
 
-    assert.dom("section > ul > li").exists({ count: 3 });
+    assert.dom("section > ul > li").exists({ count: 4 });
     assert.dom("section > ul > li").includesText("Tracking");
   });
 

frontend/tests/unit/services/docs-test.js

@@ -0,0 +1,12 @@
+import { module, test } from "qunit";
+import { setupTest } from "timed/tests/helpers";
+
+module("Unit | Service | docs", function (hooks) {
+  setupTest(hooks);
+
+  // TODO: Replace this with your real tests.
+  test("it exists", function (assert) {
+    const service = this.owner.lookup("service:docs");
+    assert.ok(service);
+  });
+});