Skip to content

Commit cf3e934

Browse files
committed
add lime-sdk
1 parent 19a974f commit cf3e934

33 files changed

Lines changed: 1299 additions & 221 deletions

.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ node_modules/
99
/docs/profiles/**
1010
!/docs/profiles/index.md
1111

12-
1312
/lime-packages
1413
/network-profiles
14+
/lime-sdk
15+
16+
/docs/build/lime-sdk.md
17+
18+
/docs/development/**
19+
!/docs/development/hacking/kernel_vermagic.md

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
[submodule "network-profiles"]
55
path = network-profiles
66
url = https://github.com/libremesh/network-profiles
7+
[submodule "lime-sdk"]
8+
path = lime-sdk
9+
url = https://github.com/libremesh/lime-sdk

docs/.vitepress/config.mts

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,13 @@ export default defineConfig({
7373

7474
function nav(): DefaultTheme.NavItem[] {
7575
return [
76+
{ text: 'Guide', link: '/guide/packages-selection' },
7677
{ text: 'Reference', link: '/reference/configuration' },
7778
{ text: 'v2024.1',
7879
items: [
7980
{ text: 'v2020.4', link: '/news/2023-10-07' },
8081
{ text: 'News', link: '/news' },
81-
{ text: 'Changelog', link: 'https://github.com/libremesh/lime-packages/tree/master/CHANGELOG.md'},
82+
{ text: 'Changelog', link: 'changelog'},
8283
{ text: 'Issues', link: 'https://github.com/libremesh/lime-packages/issues'},
8384
]
8485
},
@@ -97,7 +98,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
9798
]
9899
},
99100
{
100-
text: 'User Guide',
101+
text: 'Usage Guide',
101102
collapsed: false,
102103
items: [
103104
{ text: 'Connecting to the router', link: '/guide/connecting' },
@@ -113,19 +114,26 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
113114
collapsed: true,
114115
items: [
115116
{ text: 'Build methods', link: '/build/' },
116-
{ text: 'Imagebuilder', link: '/build/imagebuilder' },
117+
{ text: 'ImageBuilder', link: '/build/imagebuilder' },
118+
{ text: 'lime-sdk', link: '/build/lime-sdk' },
117119
{ text: 'Buildroot', link: '/build/buildroot'}
118120
]}
119121
]
120122
},
123+
{ text: 'Configuration & Reference', link: '/reference/configuration'},
121124
{
122-
text: 'Developer Guide',
125+
text: 'Development Guide',
123126
collapsed: false,
124127
items: [
125128
{ text: 'Testing Guide', link: '/development/testing' },
126129
{ text: 'Run LibreMesh on QEMU', link: '/development/virtualizing' },
127-
{ text: 'Hacking', link: '/development/hacking' },
128-
{ text: 'Contributing to lime-packages', link: '/development/contributing' }
130+
{ text: 'Hacking',
131+
link: '/development/hacking',
132+
collapsed: true,
133+
items: [
134+
{ text: 'Kernel Vermagic', link: '/development/kernel_vermagic' }
135+
] },
136+
{ text: 'Contributing to lime-packages', link: '/development/contributing' },
129137
]
130138
},
131139
{
@@ -182,24 +190,29 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
182190
items: [
183191
{ text: 'Configuration', link: 'configuration' },
184192
{ text: 'lime-config', link: 'lime-config' },
185-
{ text: 'Flavors', link: '/reference/flavors' },
193+
{ text: 'Flavors', link: 'flavors' },
186194
{ text: 'lime-files', items: [
187195
{ text: 'System options', link: 'system' },
188196
{ text: 'Network options', link: 'network/', items: [
197+
{ text: 'General options', link: 'network/#general-options'},
198+
{ text: 'DNS servers', link: 'network/#dns-servers'},
189199
{ text: 'Protocols list', link: 'network/protocols-list'},
190200
{ text: 'Protocols options', link: 'network/protocols-options'},
191-
{ text: 'Interface specific', link: 'network/interface-specific'},
201+
{ text: 'Interface specific options', link: 'network/interface-specific'},
192202
] },
193-
{ text: 'Wifi', link: 'wifi', items: [
194-
{ text: 'Band specific', link: 'wifi#wifi-band-specific-options'},
195-
{ text: 'Interface specific', link: 'wifi#wifi-interface-specific-options'},
196-
{ text: 'Client mode', link: 'wifi#wifi-client-mode'},
197-
{ text: 'Backbone AP', link: 'wifi#wifi-backbone-ap'},
203+
{ text: 'WiFi options', link: 'wifi', items: [
204+
{ text: 'General options', link: 'wifi/#general-options'},
205+
{ text: 'Band specific options', link: 'wifi/band-specific-options'},
206+
{ text: 'Interface specific options', link: 'wifi/interface-specific'},
198207
] },
199-
{ text: 'Generic UCI configs', link: 'openwrt_configs' },
200-
{ text: 'BGP', link: 'bgp' },
201-
{ text: 'Ground Routing', link: 'wifi' },
202-
{ text: 'Watchcat', link: 'watchcat' }
208+
{ text: 'Generic UCI configs', link: 'generic_config' },
209+
{ text: 'Hardware detection',
210+
link: 'hardware_detection',
211+
items: [
212+
{ text: 'Ground Routing', link: 'hardware_detection/ground_routing' },
213+
{ text: 'Watchcat', link: 'hardware_detection/watchcat' }
214+
]
215+
},
203216
]}
204217
]
205218
}

docs/.vitepress/sidebar.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ export function getFiles(path: string): Promise<INavItem[]> {
1717
return new Promise((resolve, reject) => {
1818
let navigation: INavItem[] = [];
1919
const filePath = path;
20-
console.log(path)
20+
// console.log(path)
2121
const files: string[] = glob.sync(filePath);
22-
console.log(files)
22+
// console.log(files)
2323
files.sort();
2424
for (const file of files) {
25-
console.log(file)
25+
// console.log(file)
2626
const fileData = fs.readFileSync(file).toString();
2727
const fm = matter(fileData);
2828

@@ -31,7 +31,7 @@ export function getFiles(path: string): Promise<INavItem[]> {
3131
title = file;
3232
}
3333

34-
console.log(title)
34+
// console.log(title)
3535

3636
navigation.push({
3737
title,

docs/build/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Firmware Selector request a firmware build via an [`ASU`](https://github.com
1616
### [ImageBuilder](imagebuilder)
1717
Assemble prebuilt kernel, packages and device information to produce the firmware
1818

19-
### [lime-sdk](https://github.com/libremesh/lime-sdk)
19+
### [lime-sdk](lime-sdk)
2020
Build packages using the OpenWrt SDK and firmware images using the OpenWrt ImageBuilder
2121

2222
### [Buildroot](buildroot)

0 commit comments

Comments
 (0)