diff --git a/subprojects/docs/build.gradle.kts b/subprojects/docs/build.gradle.kts index 0c80e23a6..e559ed3e6 100644 --- a/subprojects/docs/build.gradle.kts +++ b/subprojects/docs/build.gradle.kts @@ -50,7 +50,7 @@ val docusaurusOutputDir = layout.buildDirectory.dir("docusaurus") val javadocsDir = layout.buildDirectory.dir("javadocs") -val javadocsDocsDir = javadocsDir.map { root -> root.dir("api/javadoc") } +val javadocsDocsDir = javadocsDir.map { root -> root.dir("develop/javadoc") } val configFiles: FileCollection = files( rootProject.file("yarn.lock"), diff --git a/subprojects/docs/docusaurus.config.ts b/subprojects/docs/docusaurus.config.ts index 47bf605e1..00ef21b53 100644 --- a/subprojects/docs/docusaurus.config.ts +++ b/subprojects/docs/docusaurus.config.ts @@ -21,7 +21,6 @@ const markdownOptions = { export default { title: 'Refinery', tagline: 'An efficient graph solver for generating well-formed models', - titleDelimiter: '⚗️', url: 'https://refinery.tools', baseUrl: '/', baseUrlIssueBanner: false, @@ -31,9 +30,9 @@ export default { [ '@docusaurus/plugin-content-docs', { - id: 'docs', - path: 'src/docs', - routeBasePath: '/docs', + id: 'learn', + path: 'src/learn', + routeBasePath: '/learn', sidebarPath: undefined, ...markdownOptions, } satisfies DocsOptions, @@ -41,9 +40,9 @@ export default { [ '@docusaurus/plugin-content-docs', { - id: 'api', - path: 'src/docs-api', - routeBasePath: '/api', + id: 'develop', + path: 'src/develop', + routeBasePath: '/develop', sidebarPath: undefined, ...markdownOptions, } satisfies DocsOptions, @@ -81,11 +80,11 @@ export default { items: [ { label: 'Learn', - to: '/docs', + to: '/learn', }, { label: 'Develop', - to: '/api', + to: '/develop', }, { label: 'GitHub', @@ -107,19 +106,19 @@ export default { items: [ { label: 'Introduction', - to: '/docs', + to: '/learn', }, { label: 'Tutorials', - to: '/docs/category/tutorials', + to: '/learn/tutorials', }, { label: 'Langauge reference', - to: '/docs/category/language', + to: '/learn/language', }, { label: 'Run in Docker', - to: '/docs/docker', + to: '/learn/docker', }, ], }, @@ -128,15 +127,15 @@ export default { items: [ { label: 'Programming guide', - to: '/api', + to: '/develop', }, { label: 'Contributing', - to: '/api/contributing', + to: '/develop/contributing', }, { label: 'Javadoc', - to: '/api/javadoc', + to: '/develop/javadoc', }, ], }, diff --git a/subprojects/docs/src/docs-api/contributing.md b/subprojects/docs/src/develop/contributing.md similarity index 100% rename from subprojects/docs/src/docs-api/contributing.md rename to subprojects/docs/src/develop/contributing.md diff --git a/subprojects/docs/src/docs-api/index.md b/subprojects/docs/src/develop/index.md similarity index 100% rename from subprojects/docs/src/docs-api/index.md rename to subprojects/docs/src/develop/index.md diff --git a/subprojects/docs/src/docs-api/javadoc.md b/subprojects/docs/src/develop/javadoc.md similarity index 97% rename from subprojects/docs/src/docs-api/javadoc.md rename to subprojects/docs/src/develop/javadoc.md index 7e39b9b90..225e9de09 100644 --- a/subprojects/docs/src/docs-api/javadoc.md +++ b/subprojects/docs/src/develop/javadoc.md @@ -7,7 +7,7 @@ sidebar_position: 999 # Javadoc -Here 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. +Here 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. # Refinery diff --git a/subprojects/docs/src/docs/docker.md b/subprojects/docs/src/learn/docker.md similarity index 98% rename from subprojects/docs/src/docs/docker.md rename to subprojects/docs/src/learn/docker.md index c61c1457a..0df87da8c 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 Once Docker pulls and starts the container, you can navigate to http://localhost:8888 to open the model generation interface and start editing. -Alternatively, you can follow the [instructions to set up a local development environment](/api/contributing) and compile and run Refinery from source. +Alternatively, you can follow the [instructions to set up a local development environment](/develop/contributing) and compile and run Refinery from source. ## Updating diff --git a/subprojects/docs/src/docs/index.md b/subprojects/docs/src/learn/index.md similarity index 100% rename from subprojects/docs/src/docs/index.md rename to subprojects/docs/src/learn/index.md diff --git a/subprojects/docs/src/docs/language/_category_.yml b/subprojects/docs/src/learn/language/_category_.yml similarity index 89% rename from subprojects/docs/src/docs/language/_category_.yml rename to subprojects/docs/src/learn/language/_category_.yml index 7060edf32..f5a6f8966 100644 --- a/subprojects/docs/src/docs/language/_category_.yml +++ b/subprojects/docs/src/learn/language/_category_.yml @@ -6,5 +6,5 @@ position: 2 label: Language reference link: type: generated-index - slug: /category/language + slug: /language 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 similarity index 100% rename from subprojects/docs/src/docs/language/classes.md rename to 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 similarity index 92% rename from subprojects/docs/src/docs/tutorials/_category_.yml rename to subprojects/docs/src/learn/tutorials/_category_.yml index 25a06d986..adf8293fa 100644 --- a/subprojects/docs/src/docs/tutorials/_category_.yml +++ b/subprojects/docs/src/learn/tutorials/_category_.yml @@ -6,5 +6,6 @@ position: 1 label: Tutorials link: type: generated-index + slug: /tutorials title: Tutorial overview 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 similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig1.png rename to subprojects/docs/src/learn/tutorials/file-system/fig1.png diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig1.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig1.png.license similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig1.png.license rename to 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 similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig2.png rename to subprojects/docs/src/learn/tutorials/file-system/fig2.png diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig2.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig2.png.license similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig2.png.license rename to 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 similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig3.png rename to subprojects/docs/src/learn/tutorials/file-system/fig3.png diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig3.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig3.png.license similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig3.png.license rename to 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 similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig4.png rename to subprojects/docs/src/learn/tutorials/file-system/fig4.png diff --git a/subprojects/docs/src/docs/tutorials/file-system/fig4.png.license b/subprojects/docs/src/learn/tutorials/file-system/fig4.png.license similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/fig4.png.license rename to 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 similarity index 100% rename from subprojects/docs/src/docs/tutorials/file-system/index.md rename to 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 258843366..713223c26 100644 --- a/subprojects/docs/src/pages/index.tsx +++ b/subprojects/docs/src/pages/index.tsx @@ -34,7 +34,7 @@ function Hero() { Try online