-
Notifications
You must be signed in to change notification settings - Fork 9
docs: add Topo documentation homepage #358
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
Open
ZachMaso
wants to merge
5
commits into
arm:main
Choose a base branch
from
ZachMaso:agent/add-topo-docs-homepage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
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
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,5 +1,6 @@ | ||
| { | ||
| "siteLabel": "Topo", | ||
| "indexPageDirectory": "landing-page", | ||
| "navbarItems": [ | ||
| { | ||
| "label": "Documentation", | ||
|
|
||
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
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 |
|---|---|---|
| @@ -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`, | ||
| }, | ||
|
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[], | ||
| }; | ||
Oops, something went wrong.
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.