Skip to content

Commit

Permalink
docs: improve cli related (#874)
Browse files Browse the repository at this point in the history
  • Loading branch information
fanweixiao authored Aug 8, 2024
1 parent f0525f0 commit c2c4114
Show file tree
Hide file tree
Showing 7 changed files with 2,692 additions and 1,854 deletions.
16 changes: 8 additions & 8 deletions docs/components/features.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,26 @@ export type Feature = {
export type Features = Array<Feature>;

const FEATURES: Features = [
{
name: "LLM Function Calling",
description: `Strong-typed language, for OpenAI, Gemini and Ollama`,
link: "/docs/api/sfn",
Icon: WifiIcon,
},
{
name: "Low-latency",
description: `Guaranteed by implementing atop of QUIC Protocol.`,
link: "/docs/", //"https://datatracker.ietf.org/wg/quic/documents/",
Icon: BoltIcon,
},
{
name: "Geo-distributed",// Architecture",
name: "Geo-distributed",
description: `Your code close to your users.`,
link: "/docs/glossary",
Icon: GlobeAltIcon,
},
{
name: "Self-hosting",// Efficiency",
name: "Self-hosting",
description: `Less than $100 with 10K users with global scale.`,
link: "/docs/devops_tuning",
Icon: CurrencyDollarIcon,
Expand All @@ -48,12 +54,6 @@ const FEATURES: Features = [
link: "/docs/devops_tls",
Icon: LockClosedIcon,
},
{
name: "5G/WiFi-6",
description: `Networking optimized for high-speed celluar and wireless.`,
link: "/docs/api/sfn",
Icon: WifiIcon,
},
];

export default function FeatureList() {
Expand Down
8 changes: 4 additions & 4 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@
"cobe": "^0.6.3",
"focus-visible": "^5.2.0",
"intersection-observer": "^0.12.2",
"next": "^13.3.0",
"nextra": "^2.3.0",
"nextra-theme-docs": "^2.3.0",
"next": "^13.5.6",
"nextra": "^2.13.4",
"nextra-theme-docs": "^2.13.4",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-intersection-observer": "^9.4.3",
"remark-mermaid-nextra": "^0.0.4"
},
"devDependencies": {
"@next/env": "^13.3.0",
"@next/env": "^13.5.6",
"@types/node": "18.15.11",
"autoprefixer": "^10.4.14",
"next-sitemap": "^4.0.7",
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/docs/cli/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Following by [last step](./dev), we init a `accumulator-func` project, and try-r

ℹ️ YoMo Stream Function file: app.go
⌛ YoMo Stream Function building...
Success! YoMo Stream Function build.
✅ YoMo Stream Function build successful!
```

List the directory, will see `sfn.wasm`:
Expand All @@ -57,7 +57,7 @@ Remember the `yomo dev` command in last step? Now you can run it again, and you
ℹ️ YoMo Stream Function file: sfn.wasm
⌛ Create YoMo Stream Function instance...
⌛ YoMo Stream Function building...
Success! YoMo Stream Function build.
✅ YoMo Stream Function build successful!
ℹ️ YoMo Stream Function is running...
time=2023-04-16T22:02:47.717+08:00 level=INFO msg="use credential" component="Stream Function" client_id=avVuTuuEeOs94VHGUn7mb client_name=yomo-app-demo credential_name=none
time=2023-04-16T22:02:48.594+08:00 level=INFO msg="connected to zipper" component="Stream Function" client_id=avVuTuuEeOs94VHGUn7mb client_name=yomo-app-demo zipper_addr=tap.yomo.dev:9140
Expand Down Expand Up @@ -124,7 +124,7 @@ Now, we can run `yomo dev sfn.wasm` again to see the execute result:
ℹ️ YoMo Stream Function file: sfn.wasm
⌛ Create YoMo Stream Function instance...
⌛ YoMo Stream Function building...
Success! YoMo Stream Function build.
✅ YoMo Stream Function build successful!
ℹ️ YoMo Stream Function is running...
time=2023-04-16T22:29:07.897+08:00 level=INFO msg="use credential" component="Stream Function" client_id=lc-GnzDJQmNyYTwgqrw-l client_name=yomo-app-demo credential_name=none
time=2023-04-16T22:29:08.010+08:00 level=INFO msg="connected to zipper" component="Stream Function" client_id=lc-GnzDJQmNyYTwgqrw-l client_name=yomo-app-demo zipper_addr=tap.yomo.dev:9140
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/docs/cli/dev.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ yomo dev [flags] [/path/to/wasm]
ℹ️ YoMo Stream Function file: app.go
⌛ Create YoMo Stream Function instance...
⌛ YoMo Stream Function building...
Success! YoMo Stream Function build.
✅ YoMo Stream Function build successful!
ℹ️ YoMo Stream Function is running...
ℹ️ Run: /Users/fanweixiao/tmp/accumulator-func/sfn.yomo
time=2023-04-16T20:50:28.789+08:00 level=INFO msg="use credential" component="Stream Function" client_id=OW-1tB9X0AT7EivDwmM5n client_name=yomo-app-demo credential_name=none
Expand Down Expand Up @@ -90,7 +90,7 @@ Then, execute `yomo dev` again:
ℹ️ YoMo Stream Function file: app.go
⌛ Create YoMo Stream Function instance...
⌛ YoMo Stream Function building...
Success! YoMo Stream Function build.
✅ YoMo Stream Function build successful!
ℹ️ YoMo Stream Function is running...
ℹ️ Run: /Users/fanweixiao/tmp/accumulator-func/sfn.yomo
time=2023-04-16T21:25:42.149+08:00 level=INFO msg="use credential" component="Stream Function" client_id=aQkfLU0H5c_oenFvNFeLK client_name=yomo-app-demo credential_name=none
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ drwxr-xr-x@ - cc 16 Apr 21:58 .
ℹ️ YoMo Stream Function file: app.go
⌛ Create YoMo Stream Function instance...
⌛ YoMo Stream Function building...
Success! YoMo Stream Function build.
✅ YoMo Stream Function build successful!
ℹ️ YoMo Stream Function is running...
ℹ️ Run: /Users/fanweixiao/tmp/accumulator-func/sfn.yomo
sfn received 58 bytes
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export function Cobe2() {
<div style={{textAlign: "center"}}>
# YoMo

### Open source Software Edge Infra for building <br/> Low-latency Geo-distributed Applications.
Stateful Serverless Framework for Edge AI Infra

</div>

Expand Down
Loading

0 comments on commit c2c4114

Please sign in to comment.