Add a link to report an issue (#106)

* Add a link to report an issue

* Config constants

Author: mrubens

docusaurus.config.ts

@@ -1,6 +1,21 @@
 import {themes as prismThemes} from 'prism-react-renderer';
 import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
+import {
+  DISCORD_URL,
+  REDDIT_URL,
+  TWITTER_URL,
+  GITHUB_MAIN_REPO_URL,
+  GITHUB_ISSUES_MAIN_URL,
+  GITHUB_FEATURES_URL,
+  VSCODE_MARKETPLACE_URL,
+  OPEN_VSX_URL,
+  CONTACT_EMAIL,
+  CAREERS_URL,
+  WEBSITE_PRIVACY_URL,
+  EXTENSION_PRIVACY_URL,
+  GITHUB_REPO_URL
+} from './src/constants';
 
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
@@ -38,7 +53,7 @@ const config: Config = {
         docs: {
           sidebarPath: './sidebars.ts',
           routeBasePath: '/',
-          editUrl: 'https://github.com/RooVetGit/Roo-Code-Docs/edit/main/',
+          editUrl: `${GITHUB_REPO_URL}/edit/main/`,
           showLastUpdateTime: true,
         },
         blog: false, // Disable blog feature
@@ -156,12 +171,12 @@ const config: Config = {
       },
       items: [
         {
-          href: 'https://github.com/RooVetGit/Roo-Code',
+          href: GITHUB_MAIN_REPO_URL,
           label: 'GitHub',
           position: 'right',
         },
         {
-          href: 'https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline',
+          href: VSCODE_MARKETPLACE_URL,
           label: 'Install Extension',
           position: 'right',
         },
@@ -175,15 +190,15 @@ const config: Config = {
           items: [
             {
               label: 'Discord',
-              href: 'https://discord.gg/roocode',
+              href: DISCORD_URL,
             },
             {
               label: 'Reddit',
-              href: 'https://www.reddit.com/r/RooCode/',
+              href: REDDIT_URL,
             },
             {
               label: 'Twitter',
-              href: 'https://x.com/roo_code',
+              href: TWITTER_URL,
             },
           ],
         },
@@ -192,11 +207,11 @@ const config: Config = {
           items: [
             {
               label: 'Issues',
-              href: 'https://github.com/RooVetGit/Roo-Code/issues',
+              href: GITHUB_ISSUES_MAIN_URL,
             },
             {
               label: 'Feature Requests',
-              href: 'https://github.com/RooVetGit/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop',
+              href: GITHUB_FEATURES_URL,
             },
           ],
         },
@@ -205,11 +220,11 @@ const config: Config = {
           items: [
             {
               label: 'VS Code Marketplace',
-              href: 'https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline',
+              href: VSCODE_MARKETPLACE_URL,
             },
             {
               label: 'Open VSX Registry',
-              href: 'https://open-vsx.org/extension/RooVeterinaryInc/roo-cline',
+              href: OPEN_VSX_URL,
             },
           ],
         },
@@ -218,20 +233,20 @@ const config: Config = {
           items: [
             {
               label: 'Contact',
-              href: 'mailto:[email protected]',
+              href: CONTACT_EMAIL,
               target: '_self',
             },
             {
               label: 'Careers',
-              href: 'https://careers.roocode.com',
+              href: CAREERS_URL,
             },
             {
               label: 'Website Privacy Policy',
-              href: 'https://roocode.com/privacy',
+              href: WEBSITE_PRIVACY_URL,
             },
             {
               label: 'Extension Privacy Policy',
-              href: 'https://github.com/RooVetGit/Roo-Code/blob/main/PRIVACY.md',
+              href: EXTENSION_PRIVACY_URL,
             },
           ],
         },

src/components/ReportIssue/index.js

@@ -0,0 +1,22 @@
+import React from 'react';
+import {useLocation} from '@docusaurus/router';
+import {GITHUB_NEW_ISSUE_URL} from '@site/src/constants';
+import styles from './styles.module.css';
+
+export default function ReportIssue() {
+  const {pathname} = useLocation();
+  
+  const issueUrl = `${GITHUB_NEW_ISSUE_URL}?title=Documentation%20Issue:%20${encodeURIComponent(pathname)}`;
+  
+  return (
+    <div className={styles.reportContainer}>
+      <hr className={styles.separator} />
+      <div className={styles.reportLink}>
+        <span>Is this documentation incorrect or incomplete? </span>
+        <a href={issueUrl} target="_blank" rel="noopener noreferrer">
+          Report an issue on GitHub
+        </a>
+      </div>
+    </div>
+  );
+}

src/components/ReportIssue/styles.module.css

@@ -0,0 +1,20 @@
+.reportContainer {
+  margin-top: 3rem;
+  margin-bottom: 1rem;
+}
+
+.separator {
+  margin-top: 2rem;
+  margin-bottom: 1rem;
+  border: 0;
+  border-top: 1px solid var(--ifm-color-emphasis-300);
+}
+
+.reportLink {
+  font-size: 0.875rem;
+  color: var(--ifm-color-emphasis-700);
+}
+
+.reportLink a {
+  font-weight: 500;
+}

src/constants.ts

@@ -0,0 +1,28 @@
+/**
+ * Application-wide constants for use in TypeScript environments
+ */
+
+// GitHub repository information
+export const GITHUB_REPO_URL = 'https://github.com/RooVetGit/Roo-Code-Docs';
+export const GITHUB_ISSUES_URL = `${GITHUB_REPO_URL}/issues`;
+export const GITHUB_NEW_ISSUE_URL = `${GITHUB_ISSUES_URL}/new`;
+
+// Community links
+export const DISCORD_URL = 'https://discord.gg/roocode';
+export const REDDIT_URL = 'https://www.reddit.com/r/RooCode/';
+export const TWITTER_URL = 'https://x.com/roo_code';
+
+// GitHub links
+export const GITHUB_MAIN_REPO_URL = 'https://github.com/RooVetGit/Roo-Code';
+export const GITHUB_ISSUES_MAIN_URL = `${GITHUB_MAIN_REPO_URL}/issues`;
+export const GITHUB_FEATURES_URL = `${GITHUB_MAIN_REPO_URL}/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop`;
+
+// Download links
+export const VSCODE_MARKETPLACE_URL = 'https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline';
+export const OPEN_VSX_URL = 'https://open-vsx.org/extension/RooVeterinaryInc/roo-cline';
+
+// Company links
+export const CONTACT_EMAIL = 'mailto:[email protected]';
+export const CAREERS_URL = 'https://careers.roocode.com';
+export const WEBSITE_PRIVACY_URL = 'https://roocode.com/privacy';
+export const EXTENSION_PRIVACY_URL = `${GITHUB_MAIN_REPO_URL}/blob/main/PRIVACY.md`;

src/theme/DocItem/index.js

@@ -0,0 +1,12 @@
+import React from 'react';
+import DocItem from '@theme-original/DocItem';
+import ReportIssue from '@site/src/components/ReportIssue';
+
+export default function DocItemWrapper(props) {
+  return (
+    <>
+      <DocItem {...props} />
+      <ReportIssue />
+    </>
+  );
+}