Skip to content

Commit ff1e283

Browse files
zhouLionzhouLion
committed
doc: github pages
1 parent 3719263 commit ff1e283

File tree

189 files changed

+11176
-144
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

189 files changed

+11176
-144
lines changed

‎README.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -13,43 +13,43 @@ FedML, Inc. (https://fedml.ai) enables people and/or organizations to have AI ca
1313
This documentation is organized in the following sections:
1414

1515
- **Overview**
16-
- [Getting Started](docs/en/starter/getting_started.md)
17-
- [Installation](docs/en/starter/installation.md)
18-
- [Mission](docs/en/starter/mission.md)
19-
- [Overview](docs/en/starter/overview.md)
20-
- [Ecosystem](docs/en/starter/ecosystem.md)
21-
- [Oss Code Architecture](docs/en/starter/oss_code_architecture.md)
22-
- [Mlops Video](docs/en/starter/mlops_video.md)
23-
- [FAQ](docs/en/starter/faq.md)
16+
- [Getting Started](docs/starter/getting_started.md)
17+
- [Installation](docs/starter/installation.md)
18+
- [Mission](docs/starter/mission.md)
19+
- [Overview](docs/starter/overview.md)
20+
- [Ecosystem](docs/starter/ecosystem.md)
21+
- [Oss Code Architecture](docs/starter/oss_code_architecture.md)
22+
- [Mlops Video](docs/starter/mlops_video.md)
23+
- [FAQ](docs/starter/faq.md)
2424
- **FedML MLOps** - Landing FedML into Reality
25-
- [Mlops Video](docs/en/starter/mlops_video.md)
26-
- [User Guide](docs/en/mlops/user_guide.md)
27-
- [Examples](docs/en/mlops/examples.md)
28-
- [FAQ](docs/en/mlops/faq.md)
29-
- [API](docs/en/mlops/api.md)
25+
- [Mlops Video](docs/starter/mlops_video.md)
26+
- [User Guide](docs/mlops/user_guide.md)
27+
- [Examples](docs/mlops/examples.md)
28+
- [FAQ](docs/mlops/faq.md)
29+
- [API](docs/mlops/api.md)
3030
- **FedML Parrot** - Simulating the Real World
31-
- [User Guide](docs/en/simulation/user_guide.md)
32-
- [Examples](docs/en/simulation/examples.md)
33-
- [FAQ](docs/en/simulation/faq.md)
34-
- [API](docs/en/simulation/api.md)
31+
- [User Guide](docs/simulation/user_guide.md)
32+
- [Examples](docs/simulation/examples.md)
33+
- [FAQ](docs/simulation/faq.md)
34+
- [API](docs/simulation/api.md)
3535
- **FedML Octopus** - Simple Connector for Data Silos
36-
- [User Guide](docs/en/cross-silo/user_guide.md)
37-
- [Examples](docs/en/cross-silo/examples.md)
38-
- [FAQ](docs/en/cross-silo/faq.md)
39-
- [API](docs/en/cross-silo/api.md)
36+
- [User Guide](docs/cross-silo/user_guide.md)
37+
- [Examples](docs/cross-silo/examples.md)
38+
- [FAQ](docs/cross-silo/faq.md)
39+
- [API](docs/cross-silo/api.md)
4040
- **FedML BeeHive** - Collaborative Learning on Smartphones/IoTs
41-
- [User Guide](docs/en/cross-device/user_guide.md)
42-
- [Examples](docs/en/cross-device/examples.md)
43-
- [FAQ](docs/en/cross-device/faq.md)
44-
- [API](docs/en/cross-device/api.md)
41+
- [User Guide](docs/cross-device/user_guide.md)
42+
- [Examples](docs/cross-device/examples.md)
43+
- [FAQ](docs/cross-device/faq.md)
44+
- [API](docs/cross-device/api.md)
4545
- **FedML Cheetah** - Speedy Training of Large Models
46-
- [User Guide](docs/en/distributed/user_guide.md)
46+
- [User Guide](docs/distributed/user_guide.md)
4747
- **FedML Benchmarks** Benchmarks for FedNLP, FedCV, FedGraphNN and FedIoT
48-
- [Benchmark FedGrapHNN](docs/en/benchmark/fedgraphnn.md)
48+
- [Benchmark FedGrapHNN](docs/benchmark/fedgraphnn.md)
4949
- **Resources**
50-
- [Papers](docs/en/resources/papers.md)
51-
- [Video](docs/en/resources/video.md)
52-
- [Community](docs/en/resources/community.md)
50+
- [Papers](docs/resources/papers.md)
51+
- [Video](docs/resources/video.md)
52+
- [Community](docs/resources/community.md)
5353

5454
- - -
5555

‎docs/.vuepress/config.ts

+24-5
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@ import {
33
navbarEn,
44
sidebarEn,
55
navbarCn,
6-
sidebarCn
6+
sidebarCn,
7+
navbarEs,
8+
sidebarEs
79
} from './configs'
810
import { searchPlugin } from '@vuepress/plugin-search'
911

1012
export default defineUserConfig({
11-
base: process.env.DOC_BASE as `/${string}/` || '/',
13+
base: '/FedML-Doc/',
1214
lang: 'en',
1315
title: 'Welcome to FedML!',
1416
description: 'Thank you for visiting our site. This documentation provides you with everything you need to know about using the FedML platform.',
1517
locales: {
16-
'/en/': {
18+
'/': {
1719
lang: 'en',
1820
title: 'Welcome to FedML',
1921
description: 'Thank you for visiting our site. This documentation provides you with everything you need to know about using the FedML platform.',
@@ -41,12 +43,12 @@ export default defineUserConfig({
4143
* As the default locale of @vuepress/theme-default is English,
4244
* we don't need to set all of the locale fields
4345
*/
44-
'/en/': {
46+
'/': {
4547
// navbar
4648
navbar: navbarEn,
4749
// sidebar
4850
sidebar: sidebarEn,
49-
home: '/en/',
51+
home: '/starter/getting_started',
5052
// page meta
5153
editLinkText: 'Edit this page on GitHub',
5254
},
@@ -55,6 +57,7 @@ export default defineUserConfig({
5557
* Chinese locale config
5658
*/
5759
'/cn/': {
60+
home: '/cn/starter/getting_started',
5861
// navbar
5962
navbar: navbarCn,
6063
selectLanguageName: '简体中文',
@@ -83,6 +86,22 @@ export default defineUserConfig({
8386
toggleColorMode: '切换颜色模式',
8487
toggleSidebar: '切换侧边栏',
8588
},
89+
90+
/**
91+
* English locale config
92+
*
93+
* As the default locale of @vuepress/theme-default is English,
94+
* we don't need to set all of the locale fields
95+
*/
96+
'/es/': {
97+
// navbar
98+
navbar: navbarEs,
99+
// sidebar
100+
sidebar: sidebarEs,
101+
home: '/starter/getting_started',
102+
// page meta
103+
editLinkText: 'Edit this page on GitHub',
104+
},
86105
}
87106
}),
88107
// use plugins

‎docs/.vuepress/configs/navbar/cn.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ import type { NavbarConfig } from '@vuepress/theme-default'
33

44
export const navbarCn: NavbarConfig = [
55
{
6-
text: 'Get Started',
6+
text: '入门',
77
link: '/cn/starter/getting_started',
88
},
99
{
1010
text: 'API',
1111
link: '/cn/api_doc/api-core.md',
1212
},
1313
{
14-
text: 'User Guide',
14+
text: '用户指南',
1515
children: [
1616
{
1717
text: 'MLOps',
@@ -44,7 +44,7 @@ export const navbarCn: NavbarConfig = [
4444
],
4545
},
4646
{
47-
text: 'Resources',
47+
text: '资源',
4848
children: [
4949
'/cn/resources/papers.md',
5050
'/cn/resources/slides.md',

‎docs/.vuepress/configs/navbar/en.ts

+13-13
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,52 @@ import type { NavbarConfig } from '@vuepress/theme-default'
44
export const navbarEn: NavbarConfig = [
55
{
66
text: 'Get Started',
7-
link: '/en/starter/getting_started',
7+
link: '/starter/getting_started',
88
},
99
{
1010
text: 'API',
11-
link: '/en/api_doc/api-core.md',
11+
link: '/api_doc/api-core.md',
1212
},
1313
{
1414
text: 'User Guide',
1515
children: [
1616
{
1717
text: 'MLOps',
18-
link: '/en/mlops/user_guide.md',
18+
link: '/mlops/user_guide.md',
1919
},
2020
{
2121
text: 'Cross Silo',
22-
link: '/en/cross-silo/user_guide.md',
22+
link: '/cross-silo/user_guide.md',
2323
},
2424
{
2525
text: 'Cross Device',
26-
link: '/en/cross-device/user_guide.md',
26+
link: '/cross-device/user_guide.md',
2727
},
2828
{
2929
text: 'Simulation',
30-
link: '/en/simulation/user_guide.md',
30+
link: '/simulation/user_guide.md',
3131
},
3232
{
3333
text: 'FedML Cheetah',
34-
link: '/en/cheetah/user_guide.md',
34+
link: '/cheetah/user_guide.md',
3535
},
3636
{
3737
text: 'FedML Spider',
38-
link: '/en/spider/user_guide.md',
38+
link: '/spider/user_guide.md',
3939
},
4040
{
4141
text: 'Benchmark',
42-
link: '/en/benchmark/fedgraphnn.md',
42+
link: '/benchmark/fedgraphnn.md',
4343
}
4444
],
4545
},
4646
{
4747
text: 'Resources',
4848
children: [
49-
'/en/resources/papers.md',
50-
'/en/resources/slides.md',
51-
'/en/resources/video.md',
52-
'/en/resources/community.md',
49+
'/resources/papers.md',
50+
'/resources/slides.md',
51+
'/resources/video.md',
52+
'/resources/community.md',
5353
],
5454
},
5555
{

0 commit comments

Comments
 (0)