Skip to content

docs: move configuration to reference section #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 28, 2024
Merged

docs: move configuration to reference section #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e77a644
docs: move configuration to reference section
SamVerschueren Jun 28, 2024
8f6a370
Merge branch 'main' into docs/reference/configuration
Nemikolh Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions docs/tutorialkit.dev/astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ export default defineConfig({
light: './src/assets/brand/tutorialkit-logo-light.svg',
replacesTitle: true,
},
plugins: [
starlightLinksValidator({
exclude: ['../../guides/**/*'],
}),
],
plugins: [starlightLinksValidator()],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By using absolute paths instead, this seems to work. I only just noticed that other pages also use absolute paths 🤷 .

sidebar: [
{
label: 'Guides',
Expand All @@ -41,10 +37,6 @@ export default defineConfig({
label: 'Content creation',
link: '/guides/creating-content/',
},
{
label: 'Configuration',
link: '/guides/configuration/',
},
{
label: 'Deployment',
link: '/guides/deployment/',
Expand All @@ -58,6 +50,10 @@ export default defineConfig({
{
label: 'Reference',
items: [
{
label: 'Configuration',
link: '/reference/configuration/',
},
{
label: 'Theming',
link: '/reference/theming/',
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorialkit.dev/src/content/docs/guides/about.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ This documentation will guide you through the steps to build your first interact

As the first step, see the [Installation](/guides/installation/) page to learn how to generate the project, and once you do, learn the basics of creating the content and corresponding code in [Creating a Lesson](/guides/creating-content/).

This will give you the basics needed to start compiling your training materials into an interactive onboarding experience. However, you'll likely want to customize that experience to fit your specific needs. For that, TutorialKit offers a range of configuration and theming options, which we have covered in the [Configuration](/guides/configuration) page.
This will give you the basics needed to start compiling your training materials into an interactive onboarding experience. However, you'll likely want to customize that experience to fit your specific needs. For that, TutorialKit offers a range of configuration and theming options, which we have covered in the [Configuration](/reference/configuration) page.
2 changes: 1 addition & 1 deletion docs/tutorialkit.dev/src/content/docs/guides/ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The preview displays the application which is a result of applying lesson files

<Image src={uiPreviewImage} alt="TutorialKit's Preview" />

Before your application template's dev server opens a port with something to be displayed, the preview shows the preparation steps such as "Installing dependencies", "Starting HTTP server" to indicate progress to the user. Note that you can customize these steps for each lesson, chapter or part of the tutorial (see: [prepareCommands](/guides/configuration/#preparecommands) reference).
Before your application template's dev server opens a port with something to be displayed, the preview shows the preparation steps such as "Installing dependencies", "Starting HTTP server" to indicate progress to the user. Note that you can customize these steps for each lesson, chapter or part of the tutorial (see: [prepareCommands](/reference/configuration/#preparecommands) reference).

The preview updates in real-time as the user makes changes to the code, chooses to see the solution or navigates between lessons.

Expand Down
0 ...src/content/docs/guides/configuration.mdx → .../content/docs/reference/configuration.mdx
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/tutorialkit.dev/src/content/docs/reference/theming.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ For instanceof, here's an example of an info callout.

### Statuses

The statuses refer to the preview window that shows the status of the [`mainCommand`](../../guides/configuration#maincommand) and [`prepareCommands`](../../guides/configuration#preparecommands) commands.
The statuses refer to the preview window that shows the status of the [`mainCommand`](/reference/configuration#maincommand) and [`prepareCommands`](/reference/configuration#preparecommands) commands.

![Statuses](./images/theming-statuses.png)

Expand Down Expand Up @@ -464,7 +464,7 @@ The tooltip is the small popup that shows up when you hover over an item or when

### Terminal

The terminal refers to both a [read-only and an interactive terminal](../../guides/configuration#terminal).
The terminal refers to both a [read-only and an interactive terminal](/reference/configuration#terminal).

![Terminal](./images/theming-terminal.png)

Expand Down