aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects
diff options
context:
space:
mode:
authorLibravatar Kristóf Marussy <kristof@marussy.com>2024-04-10 12:48:10 +0200
committerLibravatar Kristóf Marussy <kristof@marussy.com>2024-04-10 12:48:10 +0200
commit0d0379504b4476d60275a61d0da1d6e053f67ab3 (patch)
tree813094020d5284cb4ff6be316d3c9c1a10859f59 /subprojects
parentdocs: add existing static assets (diff)
downloadrefinery-0d0379504b4476d60275a61d0da1d6e053f67ab3.tar.gz
refinery-0d0379504b4476d60275a61d0da1d6e053f67ab3.tar.zst
refinery-0d0379504b4476d60275a61d0da1d6e053f67ab3.zip
refactor(docs): URL structure
Diffstat (limited to 'subprojects')
-rw-r--r--subprojects/docs/build.gradle.kts2
-rw-r--r--subprojects/docs/docusaurus.config.ts31
-rw-r--r--subprojects/docs/src/develop/contributing.md (renamed from subprojects/docs/src/docs-api/contributing.md)0
-rw-r--r--subprojects/docs/src/develop/index.md (renamed from subprojects/docs/src/docs-api/index.md)0
-rw-r--r--subprojects/docs/src/develop/javadoc.md (renamed from subprojects/docs/src/docs-api/javadoc.md)2
-rw-r--r--subprojects/docs/src/learn/docker.md (renamed from subprojects/docs/src/docs/docker.md)2
-rw-r--r--subprojects/docs/src/learn/index.md (renamed from subprojects/docs/src/docs/index.md)0
-rw-r--r--subprojects/docs/src/learn/language/_category_.yml (renamed from subprojects/docs/src/docs/language/_category_.yml)2
-rw-r--r--subprojects/docs/src/learn/language/classes.md (renamed from subprojects/docs/src/docs/language/classes.md)0
-rw-r--r--subprojects/docs/src/learn/tutorials/_category_.yml (renamed from subprojects/docs/src/docs/tutorials/_category_.yml)1
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig1.png (renamed from subprojects/docs/src/docs/tutorials/file-system/fig1.png)bin20110 -> 20110 bytes
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig1.png.license (renamed from subprojects/docs/src/docs/tutorials/file-system/fig1.png.license)0
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig2.png (renamed from subprojects/docs/src/docs/tutorials/file-system/fig2.png)bin44020 -> 44020 bytes
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig2.png.license (renamed from subprojects/docs/src/docs/tutorials/file-system/fig2.png.license)0
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig3.png (renamed from subprojects/docs/src/docs/tutorials/file-system/fig3.png)bin26950 -> 26950 bytes
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig3.png.license (renamed from subprojects/docs/src/docs/tutorials/file-system/fig3.png.license)0
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig4.png (renamed from subprojects/docs/src/docs/tutorials/file-system/fig4.png)bin38143 -> 38143 bytes
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/fig4.png.license (renamed from subprojects/docs/src/docs/tutorials/file-system/fig4.png.license)0
-rw-r--r--subprojects/docs/src/learn/tutorials/file-system/index.md (renamed from subprojects/docs/src/docs/tutorials/file-system/index.md)0
-rw-r--r--subprojects/docs/src/pages/index.tsx4
20 files changed, 22 insertions, 22 deletions
diff --git a/subprojects/docs/build.gradle.kts b/subprojects/docs/build.gradle.kts
index 0c80e23a..e559ed3e 100644
--- a/subprojects/docs/build.gradle.kts
+++ b/subprojects/docs/build.gradle.kts
@@ -50,7 +50,7 @@ val docusaurusOutputDir = layout.buildDirectory.dir("docusaurus")
50 50
51val javadocsDir = layout.buildDirectory.dir("javadocs") 51val javadocsDir = layout.buildDirectory.dir("javadocs")
52 52
53val javadocsDocsDir = javadocsDir.map { root -> root.dir("api/javadoc") } 53val javadocsDocsDir = javadocsDir.map { root -> root.dir("develop/javadoc") }
54 54
55val configFiles: FileCollection = files( 55val configFiles: FileCollection = files(
56 rootProject.file("yarn.lock"), 56 rootProject.file("yarn.lock"),
diff --git a/subprojects/docs/docusaurus.config.ts b/subprojects/docs/docusaurus.config.ts
index 47bf605e..00ef21b5 100644
--- a/subprojects/docs/docusaurus.config.ts
+++ b/subprojects/docs/docusaurus.config.ts
@@ -21,7 +21,6 @@ const markdownOptions = {
21export default { 21export default {
22 title: 'Refinery', 22 title: 'Refinery',
23 tagline: 'An efficient graph solver for generating well-formed models', 23 tagline: 'An efficient graph solver for generating well-formed models',
24 titleDelimiter: '⚗️',
25 url: 'https://refinery.tools', 24 url: 'https://refinery.tools',
26 baseUrl: '/', 25 baseUrl: '/',
27 baseUrlIssueBanner: false, 26 baseUrlIssueBanner: false,
@@ -31,9 +30,9 @@ export default {
31 [ 30 [
32 '@docusaurus/plugin-content-docs', 31 '@docusaurus/plugin-content-docs',
33 { 32 {
34 id: 'docs', 33 id: 'learn',
35 path: 'src/docs', 34 path: 'src/learn',
36 routeBasePath: '/docs', 35 routeBasePath: '/learn',
37 sidebarPath: undefined, 36 sidebarPath: undefined,
38 ...markdownOptions, 37 ...markdownOptions,
39 } satisfies DocsOptions, 38 } satisfies DocsOptions,
@@ -41,9 +40,9 @@ export default {
41 [ 40 [
42 '@docusaurus/plugin-content-docs', 41 '@docusaurus/plugin-content-docs',
43 { 42 {
44 id: 'api', 43 id: 'develop',
45 path: 'src/docs-api', 44 path: 'src/develop',
46 routeBasePath: '/api', 45 routeBasePath: '/develop',
47 sidebarPath: undefined, 46 sidebarPath: undefined,
48 ...markdownOptions, 47 ...markdownOptions,
49 } satisfies DocsOptions, 48 } satisfies DocsOptions,
@@ -81,11 +80,11 @@ export default {
81 items: [ 80 items: [
82 { 81 {
83 label: 'Learn', 82 label: 'Learn',
84 to: '/docs', 83 to: '/learn',
85 }, 84 },
86 { 85 {
87 label: 'Develop', 86 label: 'Develop',
88 to: '/api', 87 to: '/develop',
89 }, 88 },
90 { 89 {
91 label: 'GitHub', 90 label: 'GitHub',
@@ -107,19 +106,19 @@ export default {
107 items: [ 106 items: [
108 { 107 {
109 label: 'Introduction', 108 label: 'Introduction',
110 to: '/docs', 109 to: '/learn',
111 }, 110 },
112 { 111 {
113 label: 'Tutorials', 112 label: 'Tutorials',
114 to: '/docs/category/tutorials', 113 to: '/learn/tutorials',
115 }, 114 },
116 { 115 {
117 label: 'Langauge reference', 116 label: 'Langauge reference',
118 to: '/docs/category/language', 117 to: '/learn/language',
119 }, 118 },
120 { 119 {
121 label: 'Run in Docker', 120 label: 'Run in Docker',
122 to: '/docs/docker', 121 to: '/learn/docker',
123 }, 122 },
124 ], 123 ],
125 }, 124 },
@@ -128,15 +127,15 @@ export default {
128 items: [ 127 items: [
129 { 128 {
130 label: 'Programming guide', 129 label: 'Programming guide',
131 to: '/api', 130 to: '/develop',
132 }, 131 },
133 { 132 {
134 label: 'Contributing', 133 label: 'Contributing',
135 to: '/api/contributing', 134 to: '/develop/contributing',
136 }, 135 },
137 { 136 {
138 label: 'Javadoc', 137 label: 'Javadoc',
139 to: '/api/javadoc', 138 to: '/develop/javadoc',
140 }, 139 },
141 ], 140 ],
142 }, 141 },
diff --git a/subprojects/docs/src/docs-api/contributing.md b/subprojects/docs/src/develop/contributing.md
index 4a135b81..4a135b81 100644
--- a/subprojects/docs/src/docs-api/contributing.md
+++ b/subprojects/docs/src/develop/contributing.md
diff --git a/subprojects/docs/src/docs-api/index.md b/subprojects/docs/src/develop/index.md
index 4537889e..4537889e 100644
--- a/subprojects/docs/src/docs-api/index.md
+++ b/subprojects/docs/src/develop/index.md
diff --git a/subprojects/docs/src/docs-api/javadoc.md b/subprojects/docs/src/develop/javadoc.md
index 7e39b9b9..225e9de0 100644
--- a/subprojects/docs/src/docs-api/javadoc.md
+++ b/subprojects/docs/src/develop/javadoc.md
@@ -7,7 +7,7 @@ sidebar_position: 999
7 7
8# Javadoc 8# Javadoc
9 9
10Here you can find API documentation for Refinery components automatically generated by Javadoc. We recommend reading the [Programming guide](/api) first to understand how to use these components. 10Here you can find API documentation for Refinery components automatically generated by Javadoc. We recommend reading the [Programming guide](/develop) first to understand how to use these components.
11 11
12# Refinery 12# Refinery
13 13
diff --git a/subprojects/docs/src/docs/docker.md b/subprojects/docs/src/learn/docker.md
index c61c1457..0df87da8 100644
--- a/subprojects/docs/src/docs/docker.md
+++ b/subprojects/docs/src/learn/docker.md
@@ -28,7 +28,7 @@ docker run --rm -it -p 8888:8888 ghcr.io/graphs4value/refinery
28 28
29Once Docker pulls and starts the container, you can navigate to http://localhost:8888 to open the model generation interface and start editing. 29Once Docker pulls and starts the container, you can navigate to http://localhost:8888 to open the model generation interface and start editing.
30 30
31Alternatively, you can follow the [instructions to set up a local development environment](/api/contributing) and compile and run Refinery from source. 31Alternatively, you can follow the [instructions to set up a local development environment](/develop/contributing) and compile and run Refinery from source.
32 32
33## Updating 33## Updating
34 34
diff --git a/subprojects/docs/src/docs/index.md b/subprojects/docs/src/learn/index.md
index bb28df57..bb28df57 100644
--- a/subprojects/docs/src/docs/index.md
+++ b/subprojects/docs/src/learn/index.md
diff --git a/subprojects/docs/src/docs/language/_category_.yml b/subprojects/docs/src/learn/language/_category_.yml
index 7060edf3..f5a6f896 100644
--- a/subprojects/docs/src/docs/language/_category_.yml
+++ b/subprojects/docs/src/learn/language/_category_.yml
@@ -6,5 +6,5 @@ position: 2
6label: Language reference 6label: Language reference
7link: 7link:
8 type: generated-index 8 type: generated-index
9 slug: /category/language 9 slug: /language
10 description: Learn more about the Refinery partial modeling language! 10 description: Learn more about the Refinery partial modeling language!
diff --git a/subprojects/docs/src/docs/language/classes.md b/subprojects/docs/src/learn/language/classes.md
index 7278dc35..7278dc35 100644
--- a/subprojects/docs/src/docs/language/classes.md
+++ b/subprojects/docs/src/learn/language/classes.md
diff --git a/subprojects/docs/src/docs/tutorials/_category_.yml b/subprojects/docs/src/learn/tutorials/_category_.yml
index 25a06d98..adf8293f 100644
--- a/subprojects/docs/src/docs/tutorials/_category_.yml
+++ b/subprojects/docs/src/learn/tutorials/_category_.yml
@@ -6,5 +6,6 @@ position: 1
6label: Tutorials 6label: Tutorials
7link: 7link:
8 type: generated-index 8 type: generated-index
9 slug: /tutorials
9 title: Tutorial overview 10 title: Tutorial overview
10 description: Try Refinery in practical partial modeling challenges! 11 description: Try Refinery in practical partial modeling challenges!
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig1.png b/subprojects/docs/src/learn/tutorials/file-system/fig1.png
index da30af3c..da30af3c 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig1.png
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig1.png
Binary files differ
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig1.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig1.png.license
index ff75bc7c..ff75bc7c 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig1.png.license
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig1.png.license
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig2.png b/subprojects/docs/src/learn/tutorials/file-system/fig2.png
index f42e3d3e..f42e3d3e 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig2.png
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig2.png
Binary files differ
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig2.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig2.png.license
index ff75bc7c..ff75bc7c 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig2.png.license
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig2.png.license
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig3.png b/subprojects/docs/src/learn/tutorials/file-system/fig3.png
index 9506417a..9506417a 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig3.png
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig3.png
Binary files differ
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig3.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig3.png.license
index ff75bc7c..ff75bc7c 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig3.png.license
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig3.png.license
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig4.png b/subprojects/docs/src/learn/tutorials/file-system/fig4.png
index cc012f24..cc012f24 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig4.png
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig4.png
Binary files differ
diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig4.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig4.png.license
index ff75bc7c..ff75bc7c 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/fig4.png.license
+++ b/subprojects/docs/src/learn/tutorials/file-system/fig4.png.license
diff --git a/subprojects/docs/src/docs/tutorials/file-system/index.md b/subprojects/docs/src/learn/tutorials/file-system/index.md
index 1d15512f..1d15512f 100644
--- a/subprojects/docs/src/docs/tutorials/file-system/index.md
+++ b/subprojects/docs/src/learn/tutorials/file-system/index.md
diff --git a/subprojects/docs/src/pages/index.tsx b/subprojects/docs/src/pages/index.tsx
index 25884336..713223c2 100644
--- a/subprojects/docs/src/pages/index.tsx
+++ b/subprojects/docs/src/pages/index.tsx
@@ -34,7 +34,7 @@ function Hero() {
34 Try online 34 Try online
35 </Link> 35 </Link>
36 <Link 36 <Link
37 to="/docs/docker" 37 to="/learn/docker"
38 className={clsx( 38 className={clsx(
39 'button', 39 'button',
40 'button--lg', 40 'button--lg',
@@ -45,7 +45,7 @@ function Hero() {
45 Try in Docker 45 Try in Docker
46 </Link> 46 </Link>
47 <Link 47 <Link
48 to="/docs/tutorials/file-system" 48 to="/learn/tutorials/file-system"
49 className={clsx( 49 className={clsx(
50 'button', 50 'button',
51 'button--lg', 51 'button--lg',