Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
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 docs/docs-config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"siteLabel": "Topo",
"indexPageDirectory": "landing-page",
"navbarItems": [
{
"label": "Documentation",
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You run Topo on a host and deploy to a target. The host can run Linux, macOS, or

This diagram shows where Topo runs, what it deploys, and how you iterate on a project.

![Topo host-to-target deployment and development loop](./img/topo-overview.svg)
![Topo host-to-target deployment and development loop](pathname:///img/topo-overview.svg)
Comment thread
ZachMaso marked this conversation as resolved.
Outdated

## Benefits of Topo

Expand Down
108 changes: 108 additions & 0 deletions docs/landing-page/_homepage.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
export type HomepageLink = {
label: string;
to?: string;
href?: string;
variant: "primary" | "secondary";
};

export type BottomCard = {
label: string;
title: string;
description: string;
to?: string;
href?: string;
disabled?: boolean;
cta: string;
variant: "primary" | "secondary";
};

export type CodeExample = {
label: string;
title: string;
description: string;
language: string;
code: string;
};

export const homepageContent = {
meta: {
title: "Topo",
description:
"Discover Arm device capabilities and deploy containerised software over SSH.",
},
headline: "Build on your laptop. Run on Arm with Topo.",
lead: "Topo discovers Arm device features, automatically filters supported projects, and simplifies configuration and deployment of containerised software over SSH.",
heroLinks: [
{
label: "Overview",
to: "/introduction",
variant: "primary",
},
{
label: "View repository",
href: "https://github.com/arm/topo",
variant: "secondary",
},
] as HomepageLink[],
codeExamples: {
eyebrow: "Topo workflow",
title: "Get your project running in seconds",
subtitle:
"Check device features and health, find compatible projects, and deploy over SSH without replacing your existing container workflow.",
items: [
{
label: "Check",
title: "Know the target is ready.",
description:
"Verify the host, SSH connection, target, and hardware before deploying.",
language: "shell",
code: `topo health --target pi@raspberrypi`,
},
{
label: "Discover",
title: "Find projects that fit.",
description:
"Match projects to the capabilities available on the target device.",
language: "shell",
code: `topo projects --target pi@raspberrypi`,
},
{
label: "Deploy",
title: "Ship over SSH.",
description:
"Configure, build, transfer, and start the Compose project on the target.",
language: "shell",
code: `topo deploy --target pi@raspberrypi`,
},
Comment thread
ZachMaso marked this conversation as resolved.
] as CodeExample[],
},
bottomCards: [
{
label: "Getting started",
title: "Install and deploy with Topo",
description:
"Install Topo, check a target, and deploy your first project.",
to: "/introduction/install",
cta: "Install Topo",
variant: "secondary",
},
{
label: "Project specification",
title: "Build hardware-aware projects",
description:
"Add Topo metadata to a standard Compose project.",
to: "/project-specification",
cta: "Read the specification",
variant: "secondary",
},
{
label: "Development",
title: "Contribute to Topo",
description:
"Work on Topo itself and follow the contributor workflow.",
to: "/development",
cta: "Open the guide",
variant: "secondary",
},
] as BottomCard[],
};
Loading
Loading