Skip to content

....docs #26

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 #26

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
95854f8
refactor: modularize documentation content, update navigation, and fi…
Smanikanta21 Apr 13, 2026
ca39920
chore: update metadata title and add application icons to 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
10 changes: 10 additions & 0 deletions frontend/app/dashboard/docs/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import DocumentationContent from '@/components/docs/DocumentationContent';

export default function DocumentationPage() {
return (
<div className="w-full h-full flex flex-col items-center">
<DocumentationContent />
</div>
);
}
7 changes: 7 additions & 0 deletions frontend/app/dashboard/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ export default function DashboardLayout({
</Link>

<div className="flex items-center gap-6">
<Link href="/dashboard/docs" className="text-sm font-bold text-white/50 hover:text-white transition-colors tracking-wide hidden md:flex items-center gap-1.5">
<svg className="w-4 h-4 opacity-50" fill="none" viewBox="0 0 24 24" stroke="currentColor">
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth="2" d="M9 12h6m-6 4h6m2 5H7a2 2 0 01-2-2V5a2 2 0 012-2h5.586a1 1 0 01.707.293l5.414 5.414a1 1 0 01.293.707V19a2 2 0 01-2 2z" />
</svg>
Documentation
</Link>

<button className="px-5 py-2.5 bg-primary/10 hover:bg-primary/20 border border-primary/30 text-primary hover:text-primary-hover font-bold text-sm rounded-lg transition-all shadow-[0_0_15px_rgba(255,90,0,0.2)] hover:shadow-[0_0_25px_rgba(255,90,0,0.4)] flex items-center gap-2 cursor-pointer">
<svg className="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor" strokeWidth="2.5">
<path strokeLinecap="round" strokeLinejoin="round" d="M14.752 11.168l-3.197-2.132A1 1 0 0010 9.87v4.263a1 1 0 001.555.832l3.197-2.132a1 1 0 000-1.664z" />
Expand Down
111 changes: 6 additions & 105 deletions frontend/app/docs/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,112 +1,13 @@
import React from 'react';
import { CodeBlock } from '@/components/docs/CodeBlock';

const quickStartCode = `const response = await fetch('https://api.velox.dev/v1/jobs/submit', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_API_KEY'
},
body: JSON.stringify({
language: 'python:3.11',
code: 'def solve(arr):\\n return sum(arr)\\nprint(solve([1,2,3]))',
stdin: '',
cpu_time_limit: 1000 // In milliseconds
})
});

const data = await response.json();
console.log(data);`;

const responseJson = `{
"id": "job_01h6c4g6vz42d05f32axt",
"status": "Accepted",
"time_ms": 12,
"memory_kb": 2048,
"stdout": "6\\n",
"stderr": "",
"compile_output": null
}`;
import DocumentationContent from '@/components/docs/DocumentationContent';
import Link from 'next/link';

Copilot AI Apr 13, 2026

Copy link

Choose a reason for hiding this comment

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

Link is imported but never used in this page. Please remove the unused import to avoid lint/build failures.

Suggested change
import Link from 'next/link';

Copilot uses AI. Check for mistakes.

export default function DocsPage() {
return (
<div className="max-w-4xl text-white/70 leading-relaxed font-sans pb-32">

{/* Introduction Section */}
<div id="introduction">
<h1 className="flex items-center gap-4 text-white font-extrabold text-4xl mb-6 font-outfit">
<div className="w-10 h-10 rounded-xl bg-primary/10 flex items-center justify-center border border-primary/20 shadow-[0_0_15px_rgba(255,90,0,0.1)]">
<svg className="w-6 h-6 text-primary" fill="currentColor" viewBox="0 0 24 24">
<path d="M4.5 4L10.5 19h3.5L8 4H4.5z" />
<path d="M12.5 4L18.5 19h3.5L16 4h-3.5z" className="opacity-40" />
</svg>
</div>
Velox Engine Documentation
</h1>
<p className="mt-6 text-lg">
Welcome to the official documentation for Velox. The Velox Engine is a distributed, high-performance Remote Code Execution (RCE) environment designed specifically for competitive programming, online IDEs, and judging platforms.
</p>
</div>

<hr className="my-12 border-white/10" />

{/* Architecture Section */}
<div id="architecture" className="scroll-mt-24">
<h2 className="text-white text-3xl font-extrabold font-outfit mb-6">Architecture Overview</h2>
<p className="mb-6 text-lg">
Unlike traditional judging platforms that rely on single monolithic databases to queue and process code submissions (which inevitably buckle under contest traffic loads), Velox utilizes a deeply decoupled architecture:
</p>
<div className="bg-surface/50 border border-white/10 rounded-2xl p-6 my-6 shadow-[0_4px_20px_rgba(0,0,0,0.5)]">
<ul className="text-white/70 space-y-4 list-disc list-inside m-0 pl-2">
<li><strong className="text-white">API Gateway (Go):</strong> Ingests massive concurrency streams and handles routing.</li>
<li><strong className="text-white">Redis Queue:</strong> Operates strictly as a blazingly fast in-memory task broker ensuring <code className="bg-white/10 px-1.5 py-0.5 rounded font-mono text-sm text-primary">0% packet loss</code>.</li>
<li><strong className="text-white">Worker Fleet (Docker):</strong> Instantly scales up independent, isolated sub-containers that execute untrusted code securely using Linux namespaces and cgroups.</li>
</ul>
</div>
<p className="mb-6 text-lg">
Because execution environments are pre-warmed, cold starts are effectively zero. Your users receive feedback in the exact time it takes to compile and run their script—no overhead.
</p>
</div>

<hr className="my-12 border-white/10" />

{/* Quick Start Section */}
<div id="quick-start" className="scroll-mt-24">
<h2 className="text-white text-3xl font-extrabold font-outfit mb-6">Quick Start</h2>
<p className="mb-6 text-lg">
Submitting code to Velox requires a single HTTP request. Our engine bypasses traditional complex WebSocket setups for simple polling loops, or you can supply a webhook URL for immediate asynchronous callbacks.
</p>

<h3 className="text-white/90 mt-8 mb-4">Submitting a Job</h3>
<p>To run your first code snippet, send a <code className="bg-primary/20 text-primary border border-primary/20 px-1.5 py-0.5 rounded font-mono text-sm">POST</code> request to the job submittal endpoint.</p>

<CodeBlock code={quickStartCode} language="javascript / node.js" />

<div className="bg-primary/5 border border-primary/20 rounded-xl p-4 my-6 flex items-start gap-3">
<svg className="w-5 h-5 text-primary mt-0.5 shrink-0" fill="none" viewBox="0 0 24 24" stroke="currentColor" strokeWidth={2}>
<path strokeLinecap="round" strokeLinejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" />
</svg>
<p className="m-0 text-sm text-white/80 leading-relaxed">
<strong>Note:</strong> Always ensure you are limiting the <code className="bg-white/10 px-1 py-0.5 rounded">cpu_time_limit</code> to prevent malicious users from triggering infinite loops on your workers. Max allowed value without an Enterprise license is 15000ms.
</p>
</div>

<h3 className="text-white/90 mt-8 mb-4">Understanding the Response</h3>
<p>Once the worker successfully executes your payload inside an isolated container, the engine will return detailed CPU metrics, memory traces, and output streams.</p>

<CodeBlock code={responseJson} language="json (response)" />

<p className="mt-8">
The <code className="bg-white/10 px-1 py-0.5 rounded text-primary">status</code> field will return one of the following exact competitive-programming standard verdicts: <br />
<span className="inline-block mt-3 space-x-2">
<span className="bg-success/20 text-success border border-success/30 px-2 py-1 rounded text-xs font-mono font-bold">Accepted</span>
<span className="bg-red-500/20 text-red-400 border border-red-500/30 px-2 py-1 rounded text-xs font-mono font-bold">Wrong Answer</span>
<span className="bg-secondary/20 text-secondary border border-secondary/30 px-2 py-1 rounded text-xs font-mono font-bold">Time Limit Exceeded</span>
<span className="bg-zinc-700 text-white/80 border border-zinc-600 px-2 py-1 rounded text-xs font-mono font-bold">Runtime Error</span>
</span>
</p>
</div>

<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>
Comment on lines +8 to +10

Copilot AI Apr 13, 2026

Copy link

Choose a reason for hiding this comment

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

This page renders a <main> element, but frontend/app/docs/layout.tsx already wraps children in <main>. Nesting <main> elements is invalid HTML and can confuse assistive technologies. Use a <div> here (or remove the extra wrapper) and let the layout own the single <main> landmark.

Suggested change
<main className="flex-1 w-full max-w-4xl mx-auto py-12 px-6">
<DocumentationContent />
</main>
<div className="flex-1 w-full max-w-4xl mx-auto py-12 px-6">
<DocumentationContent />
</div>

Copilot uses AI. Check for mistakes.
</div>
);
}
8 changes: 7 additions & 1 deletion frontend/app/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,14 @@ const jetbrainsMono = JetBrains_Mono({
});

export const metadata: Metadata = {
title: "Velox | High-Performance Code Execution",
title: "Velox Engine",
description: "A distributed, high-performance Online Code Judger and Remote Code Execution Engine built for developers.",

Copilot AI Apr 13, 2026

Copy link

Choose a reason for hiding this comment

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

Spelling: the metadata description says "Online Code Judger"; this should be "Online Code Judge".

Suggested change
description: "A distributed, high-performance Online Code Judger and Remote Code Execution Engine built for developers.",
description: "A distributed, high-performance Online Code Judge and Remote Code Execution Engine built for developers.",

Copilot uses AI. Check for mistakes.
applicationName: "Velox",
icons: {
icon: '/icon.svg',
shortcut: '/icon.svg',
apple: '/icon.svg',
}
};

import { SearchModal } from "@/components/ui/SearchModal";
Expand Down
2 changes: 1 addition & 1 deletion frontend/components/dashboard/LogoutButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export default function LogoutButton() {
// Clear the authentication token
localStorage.removeItem('token');
// Redirect to the login page
Comment on lines 10 to 12

Copilot AI Apr 13, 2026

Copy link

Choose a reason for hiding this comment

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

Logout is clearing localStorage.removeItem('token'), but the rest of the app uses velox_token (e.g., login sets velox_token and API interceptors read/remove it). As-is, clicking logout likely leaves the user authenticated. Update this to remove the correct key (and consider also updating the comment that still says it redirects to the login page).

Suggested change
// Clear the authentication token
localStorage.removeItem('token');
// Redirect to the login page
// Clear the authentication token used by the app
localStorage.removeItem('velox_token');
// Redirect to the home page

Copilot uses AI. Check for mistakes.
router.push('/login');
router.push('/');
};

return (
Expand Down
Loading
Loading