Skip to content

Commit

Permalink
refactor(docs): URL structure
Browse files Browse the repository at this point in the history
  • Loading branch information
kris7t committed Apr 10, 2024
1 parent 65dfc0f commit 0d03795
Show file tree
Hide file tree
Showing 20 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion subprojects/docs/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
31 changes: 15 additions & 16 deletions subprojects/docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -31,19 +30,19 @@ 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,
],
[
'@docusaurus/plugin-content-docs',
{
id: 'api',
path: 'src/docs-api',
routeBasePath: '/api',
id: 'develop',
path: 'src/develop',
routeBasePath: '/develop',
sidebarPath: undefined,
...markdownOptions,
} satisfies DocsOptions,
Expand Down Expand Up @@ -81,11 +80,11 @@ export default {
items: [
{
label: 'Learn',
to: '/docs',
to: '/learn',
},
{
label: 'Develop',
to: '/api',
to: '/develop',
},
{
label: 'GitHub',
Expand All @@ -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',
},
],
},
Expand All @@ -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',
},
],
},
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Original file line number Diff line number Diff line change
Expand Up @@ -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!
4 changes: 2 additions & 2 deletions subprojects/docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function Hero() {
Try online
</Link>
<Link
to="/docs/docker"
to="/learn/docker"
className={clsx(
'button',
'button--lg',
Expand All @@ -45,7 +45,7 @@ function Hero() {
Try in Docker
</Link>
<Link
to="/docs/tutorials/file-system"
to="/learn/tutorials/file-system"
className={clsx(
'button',
'button--lg',
Expand Down

0 comments on commit 0d03795

Please sign in to comment.