Skip to content

docs edited #29

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

Merged
RISHIK92 merged 2 commits into from
Apr 13, 2026
Merged

docs edited #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
883cdb4
refactor: introduce DocsPageTemplate and update layout to standardize…
Smanikanta21 Apr 13, 2026
563f89d
style: increase avatar size and add hover effects to dashboard layout…
Smanikanta21 Apr 13, 2026
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
frontend/package-lock.json
frontend/node_modules
backend/node_modules
.DS_Store
8 changes: 2 additions & 6 deletions frontend/app/dashboard/docs/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import React from 'react';
import DocumentationContent from '@/components/docs/DocumentationContent';
import DocsPageTemplate from '@/components/docs/DocsPageTemplate';

export default function DocumentationPage() {
return (
<div className="w-full h-full flex flex-col items-center">
<DocumentationContent />
</div>
);
return <DocsPageTemplate />;
}
4 changes: 2 additions & 2 deletions frontend/app/dashboard/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ export default function DashboardLayout({
{profile?.name || "..."}
</span>
</div>
<div className="w-10 h-10 rounded-full bg-white/10 border border-white/20 flex items-center justify-center text-sm font-bold text-white group-hover:border-primary/50 transition-colors shadow-sm overflow-hidden relative">
<div className="w-12 h-12 rounded-full bg-white/10 border border-white/20 hover:border-primary/50 hover:text-primary justify-center flex items-center justify-center text-sm font-bold text-white group-hover:border-primary/50 transition-colors shadow-sm overflow-hidden">
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This className string contains duplicated/contradictory utilities (e.g., justify-center appears twice, and both hover:border-primary/50 and group-hover:border-primary/50 are present). Cleaning these up will make the styling easier to reason about and reduce accidental regressions.

Suggested change
<div className="w-12 h-12 rounded-full bg-white/10 border border-white/20 hover:border-primary/50 hover:text-primary justify-center flex items-center justify-center text-sm font-bold text-white group-hover:border-primary/50 transition-colors shadow-sm overflow-hidden">
<div className="w-12 h-12 rounded-full bg-white/10 border border-white/20 hover:border-primary/50 hover:text-primary flex items-center justify-center text-sm font-bold text-white group-hover:border-primary/50 transition-colors shadow-sm overflow-hidden">

Copilot uses AI. Check for mistakes.
<img
src={`https://api.dicebear.com/7.x/initials/svg?seed=${profile?.name || "User"}&backgroundColor=000000&textColor=ffffff`}
alt="Avatar"
Expand All @@ -125,7 +125,7 @@ export default function DashboardLayout({
</div>
</header>

<main className="flex-1 p-8 overflow-y-auto w-full">
<main className="flex-1 p-8 w-full">
<div className="max-w-7xl mx-auto space-y-8">{children}</div>
</main>
</div>
Expand Down
5 changes: 1 addition & 4 deletions frontend/app/docs/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,8 @@ export default function DocsLayout({
return (
<div className="min-h-screen bg-background text-foreground flex flex-col">
<Navbar />
<div className="flex-1 max-w-7xl mx-auto w-full px-4 sm:px-6 lg:px-8 flex items-start gap-12">
<Sidebar />
<main className="flex-1 py-12 lg:py-16 min-w-0">
<div className="flex-1 max-w-7xl mx-auto w-full px-4 sm:px-6 lg:px-8 py-8 flex flex-col">
{children}
</main>
</div>
Comment on lines 13 to 16
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sidebar is no longer rendered in this layout, but the Sidebar import remains at the top of the file, which will be flagged by linting/TS as an unused import. Remove the unused import now that the layout delegates sidebar rendering to the child page/template.

Copilot uses AI. Check for mistakes.
<SearchModal />
</div>
Expand Down
11 changes: 2 additions & 9 deletions frontend/app/docs/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
import React from 'react';
import DocumentationContent from '@/components/docs/DocumentationContent';
import Link from 'next/link';
import DocsPageTemplate from '@/components/docs/DocsPageTemplate';

export default function DocsPage() {
return (
<div className="min-h-screen bg-background flex flex-col">
<main className="flex-1 w-full max-w-4xl mx-auto py-12 px-6">
<DocumentationContent />
</main>
</div>
);
return <DocsPageTemplate />;
}
14 changes: 14 additions & 0 deletions frontend/components/docs/DocsPageTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import React from 'react';
import { Sidebar } from '@/components/docs/Sidebar';
import DocumentationContent from '@/components/docs/DocumentationContent';

export default function DocsPageTemplate() {
return (
<div className="flex flex-col lg:flex-row items-start gap-12 w-full pt-4">
<Sidebar />
<div className="flex-1 min-w-0 w-full mb-16">
<DocumentationContent />
</div>
</div>
);
}
451 changes: 315 additions & 136 deletions frontend/components/docs/DocumentationContent.tsx
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions frontend/components/docs/Sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import Link from 'next/link';
const docLinks = [
{ name: 'Introduction', href: '/docs#introduction', id: 'introduction' },
{ name: 'Architecture', href: '/docs#architecture', id: 'architecture' },
{ name: 'Execution Lifecycle', href: '/docs#execution-lifecycle', id: 'execution-lifecycle' },
{ name: 'Quick Start', href: '/docs#quick-start', id: 'quick-start' },
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sidebar navigation label still says “Quick Start”, but the corresponding section header was renamed to “Integration & API Flow” (id remains quick-start). This mismatch can confuse users; consider renaming the sidebar item to match the section header (or revert the header text) while keeping the same anchor id.

Suggested change
{ name: 'Quick Start', href: '/docs#quick-start', id: 'quick-start' },
{ name: 'Integration & API Flow', href: '/docs#quick-start', id: 'quick-start' },

Copilot uses AI. Check for mistakes.
Comment on lines 7 to 10
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sidebar is now reused on both /docs and /dashboard/docs via DocsPageTemplate, but the link hrefs are hard-coded to the /docs#... route. While the click handler prevents navigation, copying/opening links (or non-JS navigation) will take users out of the dashboard. Consider switching to hash-only hrefs (e.g., #introduction) or making the base path configurable.

Suggested change
{ name: 'Introduction', href: '/docs#introduction', id: 'introduction' },
{ name: 'Architecture', href: '/docs#architecture', id: 'architecture' },
{ name: 'Execution Lifecycle', href: '/docs#execution-lifecycle', id: 'execution-lifecycle' },
{ name: 'Quick Start', href: '/docs#quick-start', id: 'quick-start' },
{ name: 'Introduction', href: '#introduction', id: 'introduction' },
{ name: 'Architecture', href: '#architecture', id: 'architecture' },
{ name: 'Execution Lifecycle', href: '#execution-lifecycle', id: 'execution-lifecycle' },
{ name: 'Quick Start', href: '#quick-start', id: 'quick-start' },

Copilot uses AI. Check for mistakes.
];

Expand Down
Loading