Skip to content

Commit 217c74c

Browse files
Lorenzo ArboitLorenzo Arboit
Lorenzo Arboit
authored and
Lorenzo Arboit
committed
updated documentation
1 parent f2371a7 commit 217c74c

2 files changed

Lines changed: 63 additions & 57 deletions

File tree

‎src/components/Header.tsx‎

Lines changed: 58 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
// src/components/Header.tsx
12
import { Button } from "@/components/ui/button";
23
import { Github, Download, ExternalLink } from "lucide-react";
34
import { Link } from "react-router-dom";
45

5-
const Header = () => {
6+
// NEW: add a prop type
7+
type HeaderProps = {
8+
minimal?: boolean; // when true, hide nav + buttons
9+
};
10+
11+
const Header = ({ minimal = false }: HeaderProps) => {
612
return (
713
<header className="sticky top-0 z-50 w-full border-b bg-background/95 backdrop-blur supports-[backdrop-filter]:bg-background/60">
814
{/* Grid: [logo] [centered nav] [buttons] */}
@@ -18,60 +24,64 @@ const Header = () => {
1824
</div>
1925

2026
{/* Center: Nav (truly centered, independent of side widths) */}
21-
<nav className="hidden md:flex justify-self-center items-center gap-6 min-w-0">
22-
<a href="#features" className="text-muted-foreground hover:text-foreground transition-colors">
23-
Features
24-
</a>
25-
<a href="#download" className="text-muted-foreground hover:text-foreground transition-colors">
26-
Download
27-
</a>
28-
<a
29-
href="https://github.com/your-repo"
30-
className="text-muted-foreground hover:text-foreground transition-colors"
31-
target="_blank"
32-
rel="noopener noreferrer"
33-
>
34-
GitHub
35-
</a>
36-
<a href="#about" className="text-muted-foreground hover:text-foreground transition-colors">
37-
About
38-
</a>
39-
<Link to="/docs" className="text-muted-foreground hover:text-foreground transition-colors">
40-
Documentation
41-
</Link>
42-
</nav>
43-
44-
{/* Right: Buttons */}
45-
<div className="flex items-center gap-3 justify-self-end">
46-
<Button variant="outline" size="sm" asChild>
47-
<a
48-
href="https://github.com/your-repo"
49-
target="_blank"
50-
rel="noopener noreferrer"
51-
className="flex items-center gap-2"
52-
>
53-
<Github className="h-4 w-4" />
54-
<span className="hidden sm:inline">GitHub</span>
27+
{!minimal && (
28+
<nav className="hidden md:flex justify-self-center items-center gap-6 min-w-0">
29+
<a href="#features" className="text-muted-foreground hover:text-foreground transition-colors">
30+
Features
31+
</a>
32+
<a href="#download" className="text-muted-foreground hover:text-foreground transition-colors">
33+
Download
5534
</a>
56-
</Button>
57-
<Button variant="outline" size="sm" asChild>
5835
<a
59-
href="https://arxiv.org/abs/your-paper-id"
36+
href="https://github.com/your-repo"
37+
className="text-muted-foreground hover:text-foreground transition-colors"
6038
target="_blank"
6139
rel="noopener noreferrer"
62-
className="flex items-center gap-2"
6340
>
64-
<ExternalLink className="h-4 w-4" />
65-
<span className="hidden sm:inline">Paper</span>
41+
GitHub
6642
</a>
67-
</Button>
68-
<Button size="sm" asChild>
69-
<a href="#download" className="flex items-center gap-2">
70-
<Download className="h-4 w-4" />
71-
<span className="hidden sm:inline">Download</span>
43+
<a href="#about" className="text-muted-foreground hover:text-foreground transition-colors">
44+
About
7245
</a>
73-
</Button>
74-
</div>
46+
<Link to="/docs" className="text-muted-foreground hover:text-foreground transition-colors">
47+
Documentation
48+
</Link>
49+
</nav>
50+
)}
51+
52+
{/* Right: Buttons */}
53+
{!minimal && (
54+
<div className="flex items-center gap-3 justify-self-end">
55+
<Button variant="outline" size="sm" asChild>
56+
<a
57+
href="https://github.com/your-repo"
58+
target="_blank"
59+
rel="noopener noreferrer"
60+
className="flex items-center gap-2"
61+
>
62+
<Github className="h-4 w-4" />
63+
<span className="hidden sm:inline">GitHub</span>
64+
</a>
65+
</Button>
66+
<Button variant="outline" size="sm" asChild>
67+
<a
68+
href="https://arxiv.org/abs/your-paper-id"
69+
target="_blank"
70+
rel="noopener noreferrer"
71+
className="flex items-center gap-2"
72+
>
73+
<ExternalLink className="h-4 w-4" />
74+
<span className="hidden sm:inline">Paper</span>
75+
</a>
76+
</Button>
77+
<Button size="sm" asChild>
78+
<a href="#download" className="flex items-center gap-2">
79+
<Download className="h-4 w-4" />
80+
<span className="hidden sm:inline">Download</span>
81+
</a>
82+
</Button>
83+
</div>
84+
)}
7585
</div>
7686
</header>
7787
);

‎src/pages/Documentation.tsx‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,17 @@ import { Home, Download } from "lucide-react";
88
const Documentation = () => {
99
return (
1010
<div className="min-h-screen bg-background text-foreground">
11-
<Header />
11+
<Header minimal />
1212
<main className="container px-4 py-16 space-y-16">
1313
<section className="text-center max-w-4xl mx-auto space-y-6">
1414
<Badge variant="secondary" className="uppercase tracking-wider">
1515
Documentation
1616
</Badge>
1717
<h1 className="text-4xl md:text-5xl font-bold tracking-tight text-gradient">
18-
Endoshare Knowledge Base
18+
Endoshare Documentation
1919
</h1>
2020
<p className="text-lg text-muted-foreground leading-relaxed">
21-
Learn how to configure, operate, and maintain Endoshare. This guide mirrors the
22-
main site styling to keep the experience consistent while offering in-depth
23-
workflow explanations, installation steps, and licensing details.
21+
Learn how to configure, operate, and maintain Endoshare.
2422
</p>
2523
<div className="flex flex-col sm:flex-row gap-4 justify-center">
2624
<Button variant="outline" asChild>
@@ -42,8 +40,7 @@ const Documentation = () => {
4240
<Badge variant="outline">Using Endoshare</Badge>
4341
<h2 className="text-3xl font-semibold">Core Workflows and Features</h2>
4442
<p className="text-muted-foreground">
45-
Endoshare merges, anonymizes, and prepares endoscopic videos while enforcing
46-
privacy and compliance.
43+
Endoshare merges and de-identifies endoscopic videos.
4744
</p>
4845
</div>
4946
<ol className="space-y-8 list-decimal pl-6">
@@ -213,8 +210,7 @@ const Documentation = () => {
213210
<div className="rounded-xl border p-4 space-y-2">
214211
<h4 className="font-semibold">Auditability</h4>
215212
<p className="text-muted-foreground">
216-
All processing sessions and performance metrics are logged to the shared directory to satisfy
217-
compliance requirements.
213+
All processing sessions and performance metrics are logged to the shared directory.
218214
</p>
219215
</div>
220216
</div>

0 commit comments

Comments
 (0)