Skip to content

Commit cef8a91

Browse files
javisperezjavisperez
authored
125: Add the docs site (#23)
* Add the docs folder * Create README.md * Replace atama with kit and use lorem ipsum only
1 parent 7e00899 commit cef8a91

30 files changed

+2351
-0
lines changed

‎docs/.editorconfig

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[*]
2+
charset = utf-8
3+
indent_style = space
4+
indent_size = 2
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
9+
[*.md]
10+
trim_trailing_whitespace = false

‎docs/.gitignore

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
### OSX ###
2+
# General
3+
.DS_Store
4+
.AppleDouble
5+
.LSOverride
6+
7+
# Thumbnails
8+
._*
9+
10+
# Files that might appear in the root of a volume
11+
.DocumentRevisions-V100
12+
.fseventsd
13+
.Spotlight-V100
14+
.TemporaryItems
15+
.Trashes
16+
.VolumeIcon.icns
17+
.com.apple.timemachine.donotpresent
18+
19+
# Directories potentially created on remote AFP share
20+
.AppleDB
21+
.AppleDesktop
22+
Network Trash Folder
23+
Temporary Items
24+
.apdisk
25+
26+
### Node ###
27+
# Logs
28+
logs
29+
*.log
30+
npm-debug.log*
31+
yarn-debug.log*
32+
yarn-error.log*
33+
lerna-debug.log*
34+
35+
# Diagnostic reports (https://nodejs.org/api/report.html)
36+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
37+
38+
# Runtime data
39+
pids
40+
*.pid
41+
*.seed
42+
*.pid.lock
43+
44+
# Directory for instrumented libs generated by jscoverage/JSCover
45+
lib-cov
46+
47+
# Coverage directory used by tools like istanbul
48+
coverage
49+
*.lcov
50+
51+
# nyc test coverage
52+
.nyc_output
53+
54+
# node-waf configuration
55+
.lock-wscript
56+
57+
# Compiled binary addons (https://nodejs.org/api/addons.html)
58+
build/Release
59+
60+
# Dependency directories
61+
node_modules/
62+
jspm_packages/
63+
64+
# TypeScript v1 declaration files
65+
typings/
66+
67+
# TypeScript cache
68+
*.tsbuildinfo
69+
70+
# Optional npm cache directory
71+
.npm
72+
73+
# Optional eslint cache
74+
.eslintcache
75+
76+
# Optional REPL history
77+
.node_repl_history
78+
79+
# Output of 'npm pack'
80+
*.tgz
81+
82+
# Yarn Integrity file
83+
.yarn-integrity
84+
85+
# pnpm link folder
86+
pnpm-global
87+
88+
# dotenv environment variables file
89+
.env
90+
.env.test
91+
92+
# parcel-bundler cache (https://parceljs.org/)
93+
.cache
94+
95+
# rollup.js default build output
96+
dist/
97+
98+
# vitepress build output
99+
.vitepress/dist
100+
.vitepress/cache
101+
102+
# Serverless directories
103+
.serverless/
104+
105+
# Temporary folders
106+
tmp/
107+
temp/
108+
TODOs.md
109+
src/api/index.json
110+
src/examples/data.json
111+
src/tutorial/data.json
112+
draft.md

‎docs/.vitepress/config.mts

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
appearance: 'force-dark',
6+
srcDir: 'src',
7+
title: 'KitOps',
8+
titleTemplate: 'KitOps',
9+
description: 'Documentation for KitOps',
10+
11+
head: [
12+
// ['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/favicons/apple-touch-icon.png"}],
13+
['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/favicons/favicon-32x32.png"}],
14+
['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/favicons/favicon-16x16.png"}],
15+
// ['link', { rel: "manifest", href: "/favicons/site.webmanifest"}],
16+
// ['link', { rel: "mask-icon", href: "/favicons/safari-pinned-tab.svg", color: "#3a0839"}],
17+
['link', { rel: "shortcut icon", href: "/favicon.ico"}],
18+
// ['meta', { name: "msapplication-TileColor", content: "#3a0839"}],
19+
// ['meta', { name: "msapplication-config", content: "/favicons/browserconfig.xml"}],
20+
// ['meta', { name: "theme-color", content: "#ffffff"}],
21+
],
22+
23+
lastUpdated: true,
24+
25+
// https://vitepress.dev/reference/default-theme-config
26+
themeConfig: {
27+
logo: '/logo.svg',
28+
29+
externalLinkIcon: true,
30+
31+
search: {
32+
provider: 'local'
33+
},
34+
35+
// lastUpdated: {
36+
// text: 'Updated at',
37+
// formatOptions: {
38+
// dateStyle: 'full',
39+
// timeStyle: 'medium'
40+
// }
41+
// },
42+
43+
// Top navigation
44+
nav: [
45+
{ text: 'Docs', activeMatch: `^/docs`, link: '/docs/overview' },
46+
{ text: 'Guides', activeMatch: `^/guides`, link: '/guides/index' }
47+
],
48+
49+
// Sidebar nav
50+
sidebar: [
51+
{
52+
text: 'Getting started',
53+
items: [
54+
{ text: 'Overview', link: '/docs/overview' },
55+
{ text: 'Installation', link: '/docs/installation' },
56+
]
57+
},
58+
{
59+
text: 'CLI',
60+
items: [
61+
{ text: 'Download & Install', link: '/docs/cli/installation' },
62+
{ text: 'Usage', link: '/docs/cli/usage' },
63+
{ text: 'Flags', link: '/docs/cli/flags' },
64+
]
65+
},
66+
{
67+
text: 'Manifest',
68+
items: [
69+
{ text: 'Overview', link: '/docs/manifest/overview' },
70+
{ text: 'Structure', link: '/docs/manifest/overview' },
71+
{ text: 'Building and running', link: '/docs/manifest/building-running' },
72+
{ text: 'Creating a new model', link: '/' },
73+
{ text: 'Training a model', link: '/' },
74+
{ text: 'Strategies', link: '/' },
75+
]
76+
},
77+
{
78+
text: 'MLOps with Kitfile',
79+
items: [
80+
{ text: 'Continuos integration and deployment', link: '/docs/mlops/ci-cd' },
81+
{ text: 'Monitoring and logging', link: '/docs/mlops/ci-cd' },
82+
{ text: 'Orchestration', link: '/docs/mlops/ci-cd' },
83+
{ text: 'Scalability and resources', link: '/docs/mlops/ci-cd' },
84+
]
85+
},
86+
{
87+
text: 'Advanced',
88+
items: [
89+
{ text: 'Fine-tuning', link: '/docs/mlops/ci-cd' },
90+
{ text: 'Multi-models and Multi-tasking', link: '/docs/mlops/ci-cd' },
91+
{ text: 'Parallel training', link: '/docs/mlops/ci-cd' },
92+
{ text: 'Reinforcement and deep RL', link: '/docs/mlops/ci-cd' },
93+
]
94+
},
95+
{
96+
text: 'Contribute',
97+
items: [
98+
{ text: 'Contribute to KitOps docs', link: '/' }
99+
]
100+
},
101+
{
102+
text: 'Documentation Examples',
103+
items: [
104+
{ text: 'Markdown Examples', link: '/markdown-examples' },
105+
{ text: 'Runtime API Examples', link: '/api-examples' }
106+
]
107+
}
108+
],
109+
110+
socialLinks: [
111+
{
112+
icon: 'github',
113+
link: 'https://github.com/jozu-ai/kitops'
114+
},
115+
{
116+
icon: {
117+
svg: '<svg role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 56 56" fill="none"><path d="M5.25 6.18281L27.8658 0L50.4817 6.18281V56C50.4817 56 38.4113 49.8172 27.8658 49.8172C17.3204 49.8172 5.25 56 5.25 56V6.18281Z" fill="#075550"></path><path d="M17.7325 25.3151C16.0439 25.3151 14.701 24.9033 13.7039 24.0796C12.7068 23.256 12.0393 22.1577 11.7016 20.7849L15.1995 19.501C15.296 19.9532 15.4408 20.3973 15.6338 20.8334C15.8428 21.2533 16.1162 21.6005 16.454 21.8751C16.8078 22.1496 17.2339 22.2869 17.7325 22.2869C18.5366 22.2869 19.1478 22.0366 19.5659 21.5359C20.0001 21.0191 20.2172 20.1147 20.2172 18.8226V8.84161H24.0288V18.8226C24.0288 20.8414 23.49 22.4323 22.4125 23.5951C21.351 24.7418 19.791 25.3151 17.7325 25.3151Z" fill="#3febe0"></path><path d="M35.6325 25.3346C33.9921 25.3346 32.5447 24.9873 31.2903 24.2928C30.0359 23.5984 29.0548 22.6213 28.3472 21.3615C27.6396 20.1018 27.2858 18.6321 27.2858 16.9524C27.2858 15.2728 27.6396 13.8031 28.3472 12.5433C29.0548 11.2836 30.0359 10.3065 31.2903 9.61202C32.5447 8.91755 33.9921 8.57031 35.6325 8.57031C37.289 8.57031 38.7445 8.91755 39.9989 9.61202C41.2533 10.3065 42.2344 11.2836 42.942 12.5433C43.6657 13.8031 44.0275 15.2728 44.0275 16.9524C44.0275 18.6321 43.6657 20.1018 42.942 21.3615C42.2344 22.6213 41.2533 23.5984 39.9989 24.2928C38.7445 24.9873 37.289 25.3346 35.6325 25.3346ZM35.6325 22.1852C36.4206 22.1852 37.1443 21.9914 37.8037 21.6038C38.463 21.2 38.9857 20.6105 39.3717 19.8353C39.7738 19.0601 39.9748 18.0991 39.9748 16.9524C39.9748 15.8057 39.7738 14.8448 39.3717 14.0696C38.9857 13.2943 38.463 12.7129 37.8037 12.3253C37.1443 11.9215 36.4206 11.7197 35.6325 11.7197C34.8606 11.7197 34.1449 11.9215 33.4855 12.3253C32.8262 12.7129 32.2954 13.2943 31.8934 14.0696C31.5074 14.8448 31.3144 15.8057 31.3144 16.9524C31.3144 18.0991 31.5074 19.0601 31.8934 19.8353C32.2954 20.6105 32.8262 21.2 33.4855 21.6038C34.1449 21.9914 34.8606 22.1852 35.6325 22.1852Z" fill="#3febe0"></path><path d="M12.2334 44.8154V41.8841L20.363 32H12.5952V28.6326H25.3083V31.5639L17.2511 41.4481H25.6702V44.8154H12.2334Z" fill="#3febe0"></path><path d="M35.6017 45.0735C33.0768 45.0735 31.2836 44.4679 30.2221 43.2566C29.1768 42.0453 28.6541 40.1961 28.6541 37.7089V28.6H32.4656V38.0238C32.4656 38.8152 32.538 39.5097 32.6827 40.1072C32.8436 40.6887 33.1491 41.1409 33.5994 41.4639C34.0497 41.7869 34.7172 41.9484 35.6017 41.9484C36.4862 41.9484 37.1456 41.7869 37.5798 41.4639C38.0301 41.1409 38.3277 40.6887 38.4724 40.1072C38.6332 39.5097 38.7136 38.8152 38.7136 38.0238V28.6H42.5252V37.7089C42.5252 40.1961 41.9944 42.0453 40.933 43.2566C39.8716 44.4679 38.0945 45.0735 35.6017 45.0735Z" fill="#3febe0"></path></svg>'
118+
},
119+
link: 'https://jozu.com',
120+
ariaLabel: 'JOzu Website'
121+
}
122+
],
123+
124+
footer: {
125+
license: {
126+
text: 'MIT License',
127+
link: 'https://opensource.org/licenses/MIT'
128+
},
129+
copyright: `Copyright © ${new Date().getFullYear()} Jozu`
130+
}
131+
}
132+
})

0 commit comments

Comments
 (0)