Skip to content

Commit d1ba040

Browse files
authored
Merge pull request #18 from BeyteFlow/frontend
update docs page
2 parents 108164c + 5941a9a commit d1ba040

23 files changed

Lines changed: 546 additions & 214 deletions

package-lock.json

Lines changed: 34 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
},
1111
"dependencies": {
1212
"@google/generative-ai": "^0.24.1",
13+
"@radix-ui/react-slot": "^1.2.4",
1314
"lucide-react": "^0.563.0",
1415
"next": "16.1.6",
1516
"octokit": "^5.0.5",

public/ReadmeGenAI.png

1.14 MB
Loading

public/file.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

public/globe.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

public/next.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

public/vercel.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

public/window.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/app/docs/page.tsx

Lines changed: 25 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,38 @@
1-
"use client";
2-
import React from 'react';
31
import { Navbar } from '@/components/layout/Navbar';
42
import { Footer } from '@/components/layout/Footer';
5-
import { ChevronRight, Terminal } from 'lucide-react';
3+
import { QuickStart } from '@/components/docs/QuickStart';
4+
import { DocSections } from '@/components/docs/DocSections';
5+
import { FAQ } from '@/components/docs/FAQ';
6+
import { navLinks } from '@/constants/navLinks';
67

78
export default function DocsPage() {
8-
const navLinks = [
9-
{ name: 'Home', href: '/' },
10-
{ name: 'Features', href: '/features' },
11-
{ name: 'Examples', href: '/examples' },
12-
{ name: 'Docs', href: '/docs' },
13-
];
14-
159
return (
16-
<div className="min-h-screen bg-black text-white">
10+
<div className="min-h-screen bg-black text-white relative">
11+
<div className="absolute inset-0 bg-[linear-gradient(to_right,#80808012_1px,transparent_1px),linear-gradient(to_bottom,#80808012_1px,transparent_1px)] bg-[size:40px_40px] [mask-image:radial-gradient(ellipse_60%_50%_at_50%_0%,#000_70%,transparent_100%)] pointer-events-none" />
1712
<Navbar links={navLinks} />
18-
<main className="pt-32 pb-20 max-w-7xl mx-auto px-4 flex flex-col md:flex-row gap-12">
19-
20-
{/* Sidebar Nav */}
21-
<aside className="w-full md:w-64 space-y-8">
22-
<div>
23-
<h4 className="text-xs font-bold uppercase tracking-widest text-blue-500 mb-4">Introduction</h4>
24-
<ul className="space-y-3 text-sm text-gray-400">
25-
<li className="text-white font-medium cursor-pointer">Getting Started</li>
26-
<li className="hover:text-white cursor-pointer">Core Concepts</li>
27-
<li className="hover:text-white cursor-pointer">Security</li>
28-
</ul>
29-
</div>
30-
<div>
31-
<h4 className="text-xs font-bold uppercase tracking-widest text-gray-500 mb-4">Configuration</h4>
32-
<ul className="space-y-3 text-sm text-gray-400">
33-
<li className="hover:text-white cursor-pointer">Custom Prompts</li>
34-
<li className="hover:text-white cursor-pointer">Template Styles</li>
35-
</ul>
36-
</div>
37-
</aside>
38-
39-
{/* Main Content */}
40-
<div className="flex-1 max-w-3xl">
41-
<h1 className="text-4xl font-bold mb-6">Getting Started</h1>
42-
<p className="text-gray-400 text-lg mb-8 leading-relaxed">
43-
ReadmeGenAI is designed to be plug-and-play. Our goal is to remove the friction
44-
of writing documentation so you can focus on writing code.
13+
14+
<main className="relative z-10 pt-32 pb-20">
15+
<header className="text-center max-w-4xl mx-auto px-4 mb-24">
16+
<h1 className="text-5xl md:text-7xl font-extrabold tracking-tighter mb-6">
17+
Documentation <br />
18+
<span className="bg-clip-text text-transparent bg-linear-to-b from-white to-white/40">
19+
at your fingertips.
20+
</span>
21+
</h1>
22+
<p className="text-zinc-400 text-lg md:text-xl leading-relaxed max-w-2xl mx-auto">
23+
Everything you need to know about ReadmeGenAI. From quick start guides to
24+
advanced configuration, we&apos;ve got you covered.
4525
</p>
26+
</header>
4627

47-
<div className="space-y-12">
48-
<section>
49-
<h2 className="text-2xl font-bold mb-4 flex items-center gap-2">
50-
1. Provide your URL
51-
</h2>
52-
<p className="text-gray-400 mb-4">
53-
Enter your public GitHub repository URL into the generator. Ensure the repo
54-
contains at least a main entry point (like `index.js` or `main.py`).
55-
</p>
56-
</section>
57-
58-
<section className="p-6 rounded-2xl bg-zinc-900 border border-white/5">
59-
<div className="flex items-center gap-2 mb-4 text-blue-400 font-mono text-sm">
60-
<Terminal size={16} />
61-
<span>Quick Start Command</span>
62-
</div>
63-
<code className="text-sm bg-black p-4 rounded-lg block border border-white/10 text-zinc-300">
64-
npx readmegenai@latest --repo [your-url]
65-
</code>
66-
</section>
67-
68-
<section>
69-
<h2 className="text-2xl font-bold mb-4">2. AI Analysis</h2>
70-
<p className="text-gray-400 mb-4">
71-
Our engine uses Octokit to build a virtual file tree. This tree is passed to
72-
Gemini 2.5 Flash with a specific context window optimized for software architecture.
73-
</p>
74-
</section>
75-
</div>
28+
<div className="space-y-8">
29+
<QuickStart />
30+
<DocSections />
31+
<FAQ />
7632
</div>
7733
</main>
34+
7835
<Footer />
7936
</div>
8037
);
81-
}
38+
}

0 commit comments

Comments
 (0)