chg: Fix Github icon link to point to the main repository (not docs)

ir-engine · Jan 19, 2024 · 057287c · 057287c
1 parent 1b5ca61
commit 057287c
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 22 deletions.
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -16,7 +16,7 @@ const config: Config = {
   url: cfg.site.url,                      // Set the production url of your site here
   baseUrl: cfg.site.baseURL,              // The /<baseUrl>/ pathname under which your site is served. For GitHub pages it is often '/<projectName>/'
   organizationName: cfg.github.username,  // GitHub pages organization. Usually your GitHub org/user name. Not needed when not using GitHub pages.
-  projectName: cfg.github.projectName,    // GitHub pages project. Usually your repo name. Not needed when not using GitHub pages.
+  projectName: cfg.github.docsName,       // GitHub pages project. Usually your repo name. Not needed when not using GitHub pages.
 
   // Broken Links behavior
   onBrokenLinks: 'warn',
@@ -84,7 +84,7 @@ const config: Config = {
         //{ label: 'Examples', position: cfg.navbar.menu.position, to: 'examples', },  // TODO: Uncomment when the examples pages is ready
         { label: 'Manual', position: cfg.navbar.menu.position, to: 'manual', },
         //{ label: cfg.typedoc.label, position: cfg.navbar.menu.position, href: cfg.typedoc.url },
-        { "aria-label": "GitHub", position: cfg.navbar.menu.position, className: "header-github-link", href: cfg.github.url, },
+        { "aria-label": "GitHub", position: cfg.navbar.menu.position, className: "header-github-link", href: cfg.github.projectURL, },
         //{ label: cfg.org.title, position: cfg.navbar.menu.position,  href: cfg.org.url.orgsite },
         //{ type: 'localeDropdown', position: 'right' },
       ]

diff --git a/website.config.ts b/website.config.ts
@@ -7,33 +7,35 @@
 /**
  * @description General Variables
  */
-const OrgName       = 'Ethereal Engine'
-const ProjectName   = 'Ethereal Engine'
-const OrgUsername   = 'etherealengine'
-const GHProjectName = `etherealengine-docs`
-const GHUsername    = 'EtherealEngine'
-const GHurl         = `https://github.com/${GHUsername}/${GHProjectName}`
-const SiteURL       = `https://${OrgUsername}.github.io`
-const BaseURL       = `/${GHProjectName}/`
-const FullURL       = SiteURL+BaseURL
+const OrgFullName     = 'Ethereal Engine'
+const OrgName         = 'etherealengine'
+const ProjectFullName = 'Ethereal Engine'
+const ProjectName     = 'etherealengine'
+const GHUsername      = 'EtherealEngine'
+const GHDocsName      = `${ProjectName}-docs`
+const GHDocsURL       = `https://github.com/${GHUsername}/${GHDocsName}`
+const GithubURL       = `https://github.com/${GHUsername}/${ProjectName}`
+const SiteURL         = `https://${OrgName}.github.io`
+const BaseURL         = `/${GHDocsName}/`
+const FullURL         = SiteURL+BaseURL
 
 /**
  * @description Organization Options
  */
 export const org = {
-  title         : OrgName,
-  username      : OrgUsername,
+  title         : OrgFullName,
+  username      : OrgName,
   logo          : {
-    alt         : `${OrgName} Logo`,
+    alt         : `${OrgFullName} Logo`,
     src         : 'img/logo.svg',
   },
   url           : {
-    orgsite     : `https://${OrgUsername}.org/`,
-    comsite     : `https://${OrgUsername}.com/`,
+    orgsite     : `https://${OrgName}.org/`,
+    comsite     : `https://${OrgName}.com/`,
   },
   project       : {
-    name        : ProjectName,
-    description : `${ProjectName} is an open source solution for hosting, creating and developing immersive social spaces.`,
+    name        : ProjectFullName,
+    description : `${ProjectFullName} is an open source solution for hosting, creating and developing immersive social spaces.`,
   },
 }
 
@@ -64,10 +66,11 @@ export const meta = {
  * @description GitHub repository options
  */
 export const github = {
-  username    : org.username,
-  projectName : GHProjectName,
-  url         : GHurl,
-  editURL     : `${GHurl}/blob/master/`,
+  username   : org.username,
+  docsName   : GHDocsName,
+  docsURL    : GHDocsURL,
+  editURL    : `${GHDocsURL}/blob/master/`,
+  projectURL : GithubURL,
 }
 
 /**