Skip to content

Add in-app documentation shortcuts #3169

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

Draft
malsomesh9 wants to merge 1 commit into
base: main
Choose a base branch
from
+81 −5
Draft

Add in-app documentation shortcuts #3169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 42 additions & 1 deletion src/components/LayoutSidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@ import { approvalQueries } from "@app/lib/queries";
import { build } from "@server/build";
import { useQuery } from "@tanstack/react-query";
import { ListUserOrgsResponse } from "@server/routers/org";
import { ArrowRight, ExternalLink, PanelRightOpen, Server } from "lucide-react";
import {
ArrowRight,
BookOpen,
ExternalLink,
PanelRightOpen,
Server
} from "lucide-react";
import { useTranslations } from "next-intl";
import dynamic from "next/dynamic";
import Link from "next/link";
Expand All @@ -44,6 +50,8 @@ interface LayoutSidebarProps {
hasCookiePreference: boolean;
}

const DOCS_HREF = "https://docs.pangolin.net/";

export function LayoutSidebar({
orgId,
orgs = [],
Expand Down Expand Up @@ -270,9 +278,42 @@ export function LayoutSidebar({
/>
</div>
)}
{isSidebarCollapsed && (
<div className="px-4">
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<Link
href={DOCS_HREF}
target="_blank"
rel="noopener noreferrer"
className="flex h-8 w-8 items-center justify-center rounded-md border border-border text-muted-foreground transition-colors hover:text-foreground hover:bg-sidebar-accent dark:hover:bg-sidebar-accent/50"
aria-label="Open documentation"
>
<BookOpen className="h-4 w-4" />
</Link>
</TooltipTrigger>
<TooltipContent side="right" sideOffset={8}>
<p>Documentation</p>
</TooltipContent>
</Tooltip>
</TooltipProvider>
</div>
)}

{!isSidebarCollapsed && (
<div className="px-4 space-y-2 pb-4">
<div className="text-xs text-muted-foreground text-left">
<Link
href={DOCS_HREF}
target="_blank"
rel="noopener noreferrer"
className="flex items-center justify-start gap-1"
>
Documentation
<ExternalLink size={12} />
</Link>
</div>
{loadFooterLinks() ? (
<>
{loadFooterLinks()!.map((link, index) => (
Expand Down
43 changes: 39 additions & 4 deletions src/components/SidebarSupportButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import React, { useState } from "react";
import { useForm } from "react-hook-form";
import { zodResolver } from "@hookform/resolvers/zod";
import { z } from "zod";
import { MessageCircle, CheckCircle2 } from "lucide-react";
import { BookOpen, CheckCircle2, MessageCircle } from "lucide-react";
import { useUserContext } from "@app/hooks/useUserContext";
import { useEnvContext } from "@app/hooks/useEnvContext";
import { createApiClient, formatAxiosError } from "@app/lib/api";
Expand Down Expand Up @@ -33,6 +33,9 @@ import {
FormMessage
} from "@app/components/ui/form";
import { useTranslations } from "next-intl";
import Link from "next/link";

const DOCS_HREF = "https://docs.pangolin.net/";

type SupportFormValues = {
subject: string;
Expand Down Expand Up @@ -147,9 +150,20 @@ export function SidebarSupportButton({
</PopoverTrigger>
)}
<PopoverContent className="w-80" align="start">
<p className="text-sm text-muted-foreground">
{t("supportNotAvailableDescription")}
</p>
<div className="space-y-3">
<p className="text-sm text-muted-foreground">
{t("supportNotAvailableDescription")}
</p>
<Link
href={DOCS_HREF}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-2 text-sm text-primary hover:underline"
>
<BookOpen className="h-4 w-4" />
Documentation
</Link>
</div>
</PopoverContent>
</Popover>
);
Expand Down Expand Up @@ -205,6 +219,15 @@ export function SidebarSupportButton({
<p className="text-sm text-muted-foreground text-center">
{t("supportWillContact")}
</p>
<Link
href={DOCS_HREF}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-2 text-sm text-primary hover:underline"
>
<BookOpen className="h-4 w-4" />
Documentation
</Link>
</div>
) : (
<Form {...form}>
Expand Down Expand Up @@ -264,6 +287,18 @@ export function SidebarSupportButton({
)}
/>

<div className="rounded-md border border-border/60 bg-muted/40 px-3 py-2 text-sm text-muted-foreground">
<Link
href={DOCS_HREF}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-2 text-primary hover:underline"
>
<BookOpen className="h-4 w-4" />
Documentation
</Link>
</div>

<div className="flex justify-end gap-2">
<Button
type="button"
Expand Down