-
Notifications
You must be signed in to change notification settings - Fork 6
update docs page #18
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.
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
Merged
update docs page #18
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4f25c3d
update docs page
naheel0 52a0315
Update page.tsx
naheel0 7913066
Update documentation reference from ReadmeArchitect to ReadmeGenAI
naheel0 2c1a8bc
Enhance accessibility and clipboard functionality
naheel0 b81c2d7
Improve error handling in page generation
naheel0 9460ebd
Fix metadata title and enhance description
naheel0 3b6dcef
Update page.tsx
naheel0 1150059
Update Hero.tsx
naheel0 5941a9a
Refactor gradient and mask styles in DocsPage
naheel0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,38 @@ | ||
| "use client"; | ||
| import React from 'react'; | ||
| import { Navbar } from '@/components/layout/Navbar'; | ||
| import { Footer } from '@/components/layout/Footer'; | ||
| import { ChevronRight, Terminal } from 'lucide-react'; | ||
| import { QuickStart } from '@/components/docs/QuickStart'; | ||
| import { DocSections } from '@/components/docs/DocSections'; | ||
| import { FAQ } from '@/components/docs/FAQ'; | ||
| import { navLinks } from '@/constants/navLinks'; | ||
|
|
||
| export default function DocsPage() { | ||
| const navLinks = [ | ||
| { name: 'Home', href: '/' }, | ||
| { name: 'Features', href: '/features' }, | ||
| { name: 'Examples', href: '/examples' }, | ||
| { name: 'Docs', href: '/docs' }, | ||
| ]; | ||
|
|
||
| return ( | ||
| <div className="min-h-screen bg-black text-white"> | ||
| <div className="min-h-screen bg-black text-white relative"> | ||
| <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" /> | ||
| <Navbar links={navLinks} /> | ||
| <main className="pt-32 pb-20 max-w-7xl mx-auto px-4 flex flex-col md:flex-row gap-12"> | ||
|
|
||
| {/* Sidebar Nav */} | ||
| <aside className="w-full md:w-64 space-y-8"> | ||
| <div> | ||
| <h4 className="text-xs font-bold uppercase tracking-widest text-blue-500 mb-4">Introduction</h4> | ||
| <ul className="space-y-3 text-sm text-gray-400"> | ||
| <li className="text-white font-medium cursor-pointer">Getting Started</li> | ||
| <li className="hover:text-white cursor-pointer">Core Concepts</li> | ||
| <li className="hover:text-white cursor-pointer">Security</li> | ||
| </ul> | ||
| </div> | ||
| <div> | ||
| <h4 className="text-xs font-bold uppercase tracking-widest text-gray-500 mb-4">Configuration</h4> | ||
| <ul className="space-y-3 text-sm text-gray-400"> | ||
| <li className="hover:text-white cursor-pointer">Custom Prompts</li> | ||
| <li className="hover:text-white cursor-pointer">Template Styles</li> | ||
| </ul> | ||
| </div> | ||
| </aside> | ||
|
|
||
| {/* Main Content */} | ||
| <div className="flex-1 max-w-3xl"> | ||
| <h1 className="text-4xl font-bold mb-6">Getting Started</h1> | ||
| <p className="text-gray-400 text-lg mb-8 leading-relaxed"> | ||
| ReadmeGenAI is designed to be plug-and-play. Our goal is to remove the friction | ||
| of writing documentation so you can focus on writing code. | ||
|
|
||
| <main className="relative z-10 pt-32 pb-20"> | ||
| <header className="text-center max-w-4xl mx-auto px-4 mb-24"> | ||
| <h1 className="text-5xl md:text-7xl font-extrabold tracking-tighter mb-6"> | ||
| Documentation <br /> | ||
| <span className="bg-clip-text text-transparent bg-linear-to-b from-white to-white/40"> | ||
| at your fingertips. | ||
| </span> | ||
| </h1> | ||
| <p className="text-zinc-400 text-lg md:text-xl leading-relaxed max-w-2xl mx-auto"> | ||
| Everything you need to know about ReadmeGenAI. From quick start guides to | ||
| advanced configuration, we've got you covered. | ||
| </p> | ||
| </header> | ||
|
|
||
| <div className="space-y-12"> | ||
| <section> | ||
| <h2 className="text-2xl font-bold mb-4 flex items-center gap-2"> | ||
| 1. Provide your URL | ||
| </h2> | ||
| <p className="text-gray-400 mb-4"> | ||
| Enter your public GitHub repository URL into the generator. Ensure the repo | ||
| contains at least a main entry point (like `index.js` or `main.py`). | ||
| </p> | ||
| </section> | ||
|
|
||
| <section className="p-6 rounded-2xl bg-zinc-900 border border-white/5"> | ||
| <div className="flex items-center gap-2 mb-4 text-blue-400 font-mono text-sm"> | ||
| <Terminal size={16} /> | ||
| <span>Quick Start Command</span> | ||
| </div> | ||
| <code className="text-sm bg-black p-4 rounded-lg block border border-white/10 text-zinc-300"> | ||
| npx readmegenai@latest --repo [your-url] | ||
| </code> | ||
| </section> | ||
|
|
||
| <section> | ||
| <h2 className="text-2xl font-bold mb-4">2. AI Analysis</h2> | ||
| <p className="text-gray-400 mb-4"> | ||
| Our engine uses Octokit to build a virtual file tree. This tree is passed to | ||
| Gemini 2.5 Flash with a specific context window optimized for software architecture. | ||
| </p> | ||
| </section> | ||
| </div> | ||
| <div className="space-y-8"> | ||
| <QuickStart /> | ||
| <DocSections /> | ||
| <FAQ /> | ||
| </div> | ||
| </main> | ||
|
|
||
| <Footer /> | ||
| </div> | ||
| ); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.