diff --git a/README.md b/README.md index 1d183c5..fec13be 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ Most of us aren't really writing code anymore, we're directing agents that do. B Piyaz replaces that cycle. It's not just a context layer your agents read from, it's an end-to-end project management tool that agents operate natively. Piyaz creates tasks, refines them, plans implementations, provides the right context at the right stage, and tracks everything that happens. Your agent harness doesn't need a briefing. It walks into every session knowing exactly what to do next and why. +Full setup, guides, and reference live at **[docs.piyaz.ai](https://docs.piyaz.ai)**. + --- ## Use the hosted version (no clone) diff --git a/components/home/GetStartedModal.tsx b/components/home/GetStartedModal.tsx index ae73f5f..5d89909 100644 --- a/components/home/GetStartedModal.tsx +++ b/components/home/GetStartedModal.tsx @@ -78,10 +78,8 @@ const SELF_HOST_CLI_INSTALLS: readonly CliInstall[] = [ }, ]; -const HOSTED_README_SETUP_URL = - "https://github.com/FrkAk/piyaz#use-the-hosted-version-no-clone"; -const SELF_HOST_README_SETUP_URL = - "https://github.com/FrkAk/piyaz#self-host-contribute"; +const HOSTED_DOCS_SETUP_URL = "https://docs.piyaz.ai/docs/get-started/install"; +const SELF_HOST_DOCS_SETUP_URL = "https://docs.piyaz.ai/docs/guides/self-host"; const SECTION_LABEL_CLASS = "font-mono text-[10px] font-semibold uppercase tracking-wider text-text-muted"; @@ -92,13 +90,13 @@ const MULTI_TEAM_HINT = interface FirstTimeBodyProps { /** Target-specific install snippets to render. */ cliInstalls: readonly CliInstall[]; - /** Target-specific README setup anchor. */ - readmeSetupUrl: string; + /** Target-specific docs setup URL. */ + docsSetupUrl: string; } interface ReturningBodyProps { - /** Target-specific README setup anchor. */ - readmeSetupUrl: string; + /** Target-specific docs setup URL. */ + docsSetupUrl: string; } /** @@ -115,16 +113,16 @@ export function getCliInstalls( } /** - * Select the setup guide anchor for the active deploy target. + * Select the docs setup URL for the active deploy target. * @param deployTarget - Build-time deploy target exposed to client bundles. - * @returns Hosted or self-host README setup URL. + * @returns Hosted or self-host docs setup URL. */ -export function getReadmeSetupUrl( +export function getDocsSetupUrl( deployTarget = process.env.NEXT_PUBLIC_DEPLOY_TARGET ?? "", ): string { return deployTarget === HOSTED_DEPLOY_TARGET - ? HOSTED_README_SETUP_URL - : SELF_HOST_README_SETUP_URL; + ? HOSTED_DOCS_SETUP_URL + : SELF_HOST_DOCS_SETUP_URL; } /** @@ -133,7 +131,7 @@ export function getReadmeSetupUrl( * @param props - Target-specific install copy. * @returns First-time install instructions. */ -function FirstTimeBody({ cliInstalls, readmeSetupUrl }: FirstTimeBodyProps) { +function FirstTimeBody({ cliInstalls, docsSetupUrl }: FirstTimeBodyProps) { return ( <>

@@ -172,12 +170,12 @@ function FirstTimeBody({ cliInstalls, readmeSetupUrl }: FirstTimeBodyProps) {

Full setup details (auth, updates, self-hosting) in the{" "} - project README + documentation .

@@ -191,7 +189,7 @@ function FirstTimeBody({ cliInstalls, readmeSetupUrl }: FirstTimeBodyProps) { * @param props - Target-specific setup link. * @returns Returning-user "go talk to your agent" hint. */ -function ReturningBody({ readmeSetupUrl }: ReturningBodyProps) { +function ReturningBody({ docsSetupUrl }: ReturningBodyProps) { return ( <>

@@ -214,12 +212,12 @@ function ReturningBody({ readmeSetupUrl }: ReturningBodyProps) { Setting up another tool, or starting from a fresh machine? Install commands live in the{" "} - project README + documentation .

@@ -240,7 +238,7 @@ export function GetStartedModal({ hasProjects = false, }: GetStartedModalProps) { const cliInstalls = getCliInstalls(); - const readmeSetupUrl = getReadmeSetupUrl(); + const docsSetupUrl = getDocsSetupUrl(); return (
{hasProjects ? ( - + ) : ( )}
diff --git a/components/layout/TopBar.tsx b/components/layout/TopBar.tsx index 121d87c..b28e7af 100644 --- a/components/layout/TopBar.tsx +++ b/components/layout/TopBar.tsx @@ -7,12 +7,15 @@ import { useCommandPalette } from "@/components/layout/CommandPaletteProvider"; import { useMobileNav } from "@/components/layout/MobileNav"; import { Kbd } from "@/components/shared/Kbd"; import { + IconDoc, IconMenu, IconMoon, IconSearch, IconSun, } from "@/components/shared/icons"; +const DOCS_URL = "https://docs.piyaz.ai"; + interface TopBarProps { /** @param projectName - Optional project crumb label. When set, renders the project breadcrumb pill. */ projectName?: string; @@ -116,6 +119,21 @@ export function TopBar({ aria-hidden="true" className="mx-1 hidden h-4 w-px bg-border md:inline-block" /> + + + Docs + +