Skip to content

Commit 3d7545f

Browse files
ox-harrisox-harris
committed
Restructure docs
1 parent 8e31654 commit 3d7545f

File tree

76 files changed

+394
-588
lines changed

Some content is hidden

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

76 files changed

+394
-588
lines changed

‎README.md‎

Lines changed: 59 additions & 246 deletions
Large diffs are not rendered by default.

‎site/.vitepress/cache/deps/_metadata.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
{
2-
"hash": "3c0d8579",
2+
"hash": "13a43e04",
33
"configHash": "60d1ba4e",
4-
"lockfileHash": "ebc311e6",
5-
"browserHash": "7ea565f6",
4+
"lockfileHash": "2e4b4742",
5+
"browserHash": "2ec76131",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "7826d1ee",
10+
"fileHash": "30804b11",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "d4acb195",
16+
"fileHash": "c8689437",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "ad0c8330",
22+
"fileHash": "5de6055d",
2323
"needsInterop": false
2424
},
2525
"vitepress > @vueuse/integrations/useFocusTrap": {
2626
"src": "../../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
2727
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
28-
"fileHash": "1b26d143",
28+
"fileHash": "0fcc6ddb",
2929
"needsInterop": false
3030
},
3131
"vitepress > mark.js/src/vanilla.js": {
3232
"src": "../../../../node_modules/mark.js/src/vanilla.js",
3333
"file": "vitepress___mark__js_src_vanilla__js.js",
34-
"fileHash": "054dd96b",
34+
"fileHash": "1eaaa2c6",
3535
"needsInterop": false
3636
},
3737
"vitepress > minisearch": {
3838
"src": "../../../../node_modules/minisearch/dist/es/index.js",
3939
"file": "vitepress___minisearch.js",
40-
"fileHash": "6bfc35b9",
40+
"fileHash": "ec80c066",
4141
"needsInterop": false
4242
}
4343
},

‎site/.vitepress/config.ts‎

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ export default defineConfig({
1616
],
1717
// Top nav
1818
nav: [
19-
{ text: 'What is LinkedQL', link: '/docs/about' },
20-
{ text: 'Capabilities', link: '/docs/capabilities' },
21-
{ text: 'FlashQL', link: '/docs/flashql' },
19+
{ text: 'What is LinkedQL', link: '/overview', activeMatch: '/overview' },
20+
{ text: 'Capabilities', link: '/capabilities', activeMatch: '/capabilities' },
2221
{ text: 'Docs', link: '/docs', activeMatch: '/docs' },
22+
{ text: 'FlashQL', link: '/flashql', activeMatch: '/flashql' },
2323
{ text: 'Engineering', link: '/engineering/realtime-engine', activeMatch: '/engineering' },
2424
{
2525
text: 'Star on GitHub',
@@ -31,9 +31,9 @@ export default defineConfig({
3131
sidebar: {
3232
'/': [
3333
{
34-
text: 'Intro',
34+
text: 'Overview',
3535
items: [
36-
{ text: 'What is LinkedQL', link: '/docs/about' },
36+
{ text: 'What is LinkedQL', link: '/overview' },
3737
]
3838
},
3939
{
@@ -42,31 +42,24 @@ export default defineConfig({
4242
{ text: 'Getting Started', link: '/docs' },
4343
{ text: 'Dialects & Clients', link: '/docs/setup' },
4444
{ text: 'Query Interface', link: '/docs/query-api' },
45-
{
46-
text: 'Capabilities',
47-
link: '/docs/capabilities',
48-
collapsed: false,
49-
items: [
50-
{ text: 'DeepRefs', link: '/docs/capabilities/deeprefs' },
51-
{ text: 'JSON Literals', link: '/docs/capabilities/json-literals' },
52-
{ text: 'UPSERT', link: '/docs/capabilities/upsert' },
53-
{ text: 'Realtime SQL', link: '/docs/capabilities/realtime-sql' },
54-
]
55-
},
45+
]
46+
},
47+
{
48+
text: 'Capabilities',
49+
items: [
50+
{ text: 'Capabilities Overview', link: '/capabilities' },
51+
{ text: 'DeepRefs', link: '/capabilities/deeprefs' },
52+
{ text: 'JSON Literals', link: '/capabilities/json-literals' },
53+
{ text: 'UPSERT', link: '/capabilities/upsert' },
54+
{ text: 'Realtime SQL', link: '/capabilities/realtime-sql' },
5655
]
5756
},
5857
{
5958
text: 'FlashQL',
6059
items: [
61-
{
62-
text: 'FlashQL',
63-
link: '/docs/flashql',
64-
collapsed: false,
65-
items: [
66-
{ text: 'Foreign I/O', link: '/docs/flashql/foreign-io' },
67-
{ text: 'Language Reference', link: '/docs/flashql/lang' },
68-
]
69-
},
60+
{ text: 'FlashQL Overview', link: '/flashql' },
61+
{ text: 'Federation & Sync', link: '/flashql/foreign-io' },
62+
{ text: 'Language Reference', link: '/flashql/lang' },
7063
]
7164
},
7265
{
@@ -89,7 +82,7 @@ export default defineConfig({
8982
},
9083

9184
// VitePress defaults are great; you can add head tags here if needed
92-
head: [['meta', { name: 'theme-color', content: '#0f172a' }]],
85+
head: [['meta', { name: 'theme-color', content: 'gold' }]],
9386

9487
lang: 'en-US',
9588
base: '/',

‎site/.vitepress/dist/404.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
<title>404 | LinkedQL</title>
77
<meta name="description" content="Not Found">
88
<meta name="generator" content="VitePress v1.6.4">
9-
<link rel="preload stylesheet" href="/assets/style.DenYvuB5.css" as="style">
9+
<link rel="preload stylesheet" href="/assets/style.DxeyQAKk.css" as="style">
1010
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
1111

12-
<script type="module" src="/assets/app.BP20VcJp.js"></script>
12+
<script type="module" src="/assets/app.BuoupY3R.js"></script>
1313
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
14-
<meta name="theme-color" content="#0f172a">
14+
<meta name="theme-color" content="gold">
1515
<script id="check-dark-mode">document.documentElement.classList.add("dark");</script>
1616
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
1717
</head>
1818
<body>
1919
<div id="app"></div>
20-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"docs.md\":\"MNMJb9kL\",\"docs_about.md\":\"DrepVCIC\",\"docs_capabilities.md\":\"Mbbn3RuH\",\"docs_capabilities_deeprefs.md\":\"y_KbpCLq\",\"docs_capabilities_json-literals.md\":\"U40ly4PI\",\"docs_capabilities_realtime-sql.md\":\"LaB-ajfe\",\"docs_capabilities_upsert.md\":\"D-WocDf2\",\"docs_flashql.md\":\"DLO85vTc\",\"docs_flashql_foreign-io.md\":\"_hUyYjjq\",\"docs_flashql_lang.md\":\"BXDNFxCi\",\"docs_query-api.md\":\"Bm3w2F7m\",\"docs_setup.md\":\"xW8pIM-m\",\"engineering_realtime-engine.md\":\"CuG9ub7L\",\"index.md\":\"BsUu5Xl8\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"LinkedQL\",\"description\":\"A modern take on SQL and SQL databases — with reactivity, versioning, and more.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":\"force-dark\",\"themeConfig\":{\"logo\":{\"src\":\"/img/brand/linked-ql-logo.png\",\"height\":140},\"siteTitle\":false,\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/linked-db/linked-ql\"}],\"nav\":[{\"text\":\"What is LinkedQL\",\"link\":\"/docs/about\"},{\"text\":\"Capabilities\",\"link\":\"/docs/capabilities\"},{\"text\":\"FlashQL\",\"link\":\"/docs/flashql\"},{\"text\":\"Docs\",\"link\":\"/docs\",\"activeMatch\":\"/docs\"},{\"text\":\"Engineering\",\"link\":\"/engineering/realtime-engine\",\"activeMatch\":\"/engineering\"},{\"text\":\"Star on GitHub\",\"link\":\"https://github.com/linked-db/linked-ql\"}],\"sidebar\":{\"/\":[{\"text\":\"Intro\",\"items\":[{\"text\":\"What is LinkedQL\",\"link\":\"/docs/about\"}]},{\"text\":\"Docs\",\"items\":[{\"text\":\"Getting Started\",\"link\":\"/docs\"},{\"text\":\"Dialects & Clients\",\"link\":\"/docs/setup\"},{\"text\":\"Query Interface\",\"link\":\"/docs/query-api\"},{\"text\":\"Capabilities\",\"link\":\"/docs/capabilities\",\"collapsed\":false,\"items\":[{\"text\":\"DeepRefs\",\"link\":\"/docs/capabilities/deeprefs\"},{\"text\":\"JSON Literals\",\"link\":\"/docs/capabilities/json-literals\"},{\"text\":\"UPSERT\",\"link\":\"/docs/capabilities/upsert\"},{\"text\":\"Realtime SQL\",\"link\":\"/docs/capabilities/realtime-sql\"}]}]},{\"text\":\"FlashQL\",\"items\":[{\"text\":\"FlashQL\",\"link\":\"/docs/flashql\",\"collapsed\":false,\"items\":[{\"text\":\"Foreign I/O\",\"link\":\"/docs/flashql/foreign-io\"},{\"text\":\"Language Reference\",\"link\":\"/docs/flashql/lang\"}]}]},{\"text\":\"Engineering\",\"items\":[{\"text\":\"Realtime Engine\",\"link\":\"/engineering/realtime-engine\"}]}]},\"footer\":{\"message\":\"MIT Licensed\",\"copyright\":\"© Oxford Harrison\"},\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
20+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"capabilities.md\":\"BztTe5GT\",\"capabilities_deeprefs.md\":\"CYOx2SXL\",\"capabilities_json-literals.md\":\"rGE9X-tr\",\"capabilities_live-queries.md\":\"CHhoCYV3\",\"capabilities_upsert.md\":\"hDNJkkyH\",\"docs.md\":\"CwIgAZwB\",\"docs_query-api.md\":\"Bm8hN7oZ\",\"docs_setup.md\":\"xW8pIM-m\",\"engineering_realtime-engine.md\":\"D0WkL5Ze\",\"flashql.md\":\"dxGRqIGO\",\"flashql_foreign-io.md\":\"B-X4SFru\",\"flashql_lang.md\":\"-dKEfD4V\",\"index.md\":\"BsUu5Xl8\",\"overview.md\":\"CIcdfHfj\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"LinkedQL\",\"description\":\"A modern take on SQL and SQL databases — with reactivity, versioning, and more.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":\"force-dark\",\"themeConfig\":{\"logo\":{\"src\":\"/img/brand/linked-ql-logo.png\",\"height\":140},\"siteTitle\":false,\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/linked-db/linked-ql\"}],\"nav\":[{\"text\":\"What is LinkedQL\",\"link\":\"/overview\",\"activeMatch\":\"/overview\"},{\"text\":\"Capabilities\",\"link\":\"/capabilities\",\"activeMatch\":\"/capabilities\"},{\"text\":\"Docs\",\"link\":\"/docs\",\"activeMatch\":\"/docs\"},{\"text\":\"FlashQL\",\"link\":\"/flashql\",\"activeMatch\":\"/flashql\"},{\"text\":\"Engineering\",\"link\":\"/engineering/realtime-engine\",\"activeMatch\":\"/engineering\"},{\"text\":\"Star on GitHub\",\"link\":\"https://github.com/linked-db/linked-ql\"}],\"sidebar\":{\"/\":[{\"text\":\"Overview\",\"items\":[{\"text\":\"What is LinkedQL\",\"link\":\"/overview\"}]},{\"text\":\"Docs\",\"items\":[{\"text\":\"Getting Started\",\"link\":\"/docs\"},{\"text\":\"Dialects & Clients\",\"link\":\"/docs/setup\"},{\"text\":\"Query Interface\",\"link\":\"/docs/query-api\"}]},{\"text\":\"Capabilities\",\"items\":[{\"text\":\"Capabilities Overview\",\"link\":\"/capabilities\"},{\"text\":\"DeepRefs\",\"link\":\"/capabilities/deeprefs\"},{\"text\":\"JSON Literals\",\"link\":\"/capabilities/json-literals\"},{\"text\":\"UPSERT\",\"link\":\"/capabilities/upsert\"},{\"text\":\"Realtime SQL\",\"link\":\"/capabilities/realtime-sql\"}]},{\"text\":\"FlashQL\",\"items\":[{\"text\":\"FlashQL Overview\",\"link\":\"/flashql\"},{\"text\":\"Federation & Sync\",\"link\":\"/flashql/foreign-io\"},{\"text\":\"Language Reference\",\"link\":\"/flashql/lang\"}]},{\"text\":\"Engineering\",\"items\":[{\"text\":\"Realtime Engine\",\"link\":\"/engineering/realtime-engine\"}]}]},\"footer\":{\"message\":\"MIT Licensed\",\"copyright\":\"© Oxford Harrison\"},\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
2121

2222
</body>
2323
</html>

site/.vitepress/dist/assets/app.BP20VcJp.js renamed to site/.vitepress/dist/assets/app.BuoupY3R.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)