Skip to content

Commit

Permalink
1.9 docs: Update structure (#7036)
Browse files Browse the repository at this point in the history
  • Loading branch information
@NigelBreslaw
NigelBreslaw authored Dec 9, 2024
1 parent d154cde commit cbd6f09
Show file tree
Hide file tree
Showing 47 changed files with 919 additions and 1,054 deletions.
204 changes: 120 additions & 84 deletions docs/astro/astro.config.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,20 @@ export default defineConfig({
{ label: "Overview", slug: "index" },
{
label: "Tooling",
items: [
"guide/tooling/slintpad",
"guide/tooling/vscode",
"guide/tooling/live-editor",
],
collapsed: true,
items: ["guide/tooling/vscode"],
},
{
label: "Language",
collapsed: true,
items: [
{
label: "Core Concepts",
label: "Concepts",
items: [
{
label: "Slint Language",
slug: "guide/language/concepts/slint-language",
},
{
label: "Components and Properties",
slug: "guide/language/concepts/component-property",
Expand All @@ -76,83 +78,119 @@ export default defineConfig({
label: "Reactivity",
slug: "guide/language/concepts/reactivity",
},
{
label: "Purity",
slug: "guide/language/concepts/purity",
},
],
},
{
label: "Syntax",
label: "Coding",
items: [
{
label: "The `.slint` File",
slug: "guide/language/syntax/file",
slug: "guide/language/coding/file",
},
{
label: "Basics",
slug: "guide/language/syntax/basics",
label: "Properties",
slug: "guide/language/coding/properties",
},
{
label: "Syntax",
slug: "guide/language/syntax/syntax",
label: "Expressions and Statements",
slug: "guide/language/coding/expressions-and-statements",
},
{
label: "Positioning & Layouts",
slug: "guide/language/syntax/positioning-and-layouts",
slug: "guide/language/coding/positioning-and-layouts",
},
{
label: "In App Communication",
slug: "guide/language/coding/in-app-communication",
},
{
label: "Globals",
slug: "guide/language/coding/globals",
},
{
label: "Repetition and Data Models",
slug: "guide/language/coding/repetition-and-data-models",
},
{
label: "Animations",
slug: "guide/language/coding/animation",
},
{
label: "States and Transitions",
slug: "guide/language/coding/states",
},
{
label: "Functions and Callbacks",
slug: "guide/language/coding/functions-and-callbacks",
},
{
label: "Name Resolution (Scope)",
slug: "guide/language/coding/name-resolution",
},
{
label: "Structs and Enums",
slug: "guide/language/coding/structs-and-enums",
},
"guide/language/syntax/expressions",
"guide/language/syntax/functions",
"guide/language/syntax/callbacks",
"guide/language/syntax/globals",
"guide/language/syntax/modules",
"guide/language/syntax/properties",
"guide/language/syntax/statements",
],
},
{
label: "Advanced",
items: [
"guide/language/advanced/animation",
"guide/language/advanced/states",
"guide/language/advanced/repetitions",
"guide/language/advanced/container",
],
},
],
},
{
label: "App Development",
collapsed: true,
items: [
"guide/development/debugging_techniques",
"guide/development/localization",
"guide/development/fonts",
"guide/development/focus",
"guide/development/translations",
"guide/development/fonts",
{
label: "Accessibility",
slug: "guide/development/accessibility",
},
{
label: "Custom Controls",
slug: "guide/development/custom-controls",
},
],
},
{
label: "Platforms",
collapsed: true,
items: [
"guide/platforms/desktop",
"guide/platforms/embedded",
"guide/platforms/mobile",
],
},
{
label: "Backends and Renderers",
collapsed: true,
autogenerate: {
directory: "guide/backends-and-renderers",
},
},
],
},
{
label: "Reference",
link: "reference/overview",
link: "reference/slint-language",
icon: "information",
items: [
{
label: "Common details",
slug: "reference/overview",
label: "Slint Language",
slug: "reference/slint-language",
},
{
label: "Basics",
collapsed: true,
items: [
"reference/builtins/types",
"reference/builtins/type-conversions",
"reference/builtins/builtinfunctions",
"reference/builtins/colors",
"reference/builtins/math",
"reference/builtins/animations",
"reference/builtins/key",
],
label: "Primitive Types",
slug: "reference/primitive-types",
},
{
label: "Colors & Brushes",
slug: "reference/colors-and-brushes",
},
{
label: "Common Properties & Callbacks",
slug: "reference/common",
},
{
label: "Basic Elements",
Expand Down Expand Up @@ -221,6 +259,24 @@ export default defineConfig({
},
],
},
{
label: "Global Structs and Enums",
slug: "reference/global-structs-enums",
},
{
label: "Global Functions and Enums",
collapsed: true,
items: [
{
label: "Math",
slug: "reference/global-functions-enums/math",
},
{
label: "animation-tick() / debug()",
slug: "reference/global-functions-enums/builtinfunctions",
},
],
},
],
},
{
Expand Down Expand Up @@ -272,48 +328,28 @@ export default defineConfig({
],
},
{
label: "Platforms & Integrations",
link: "platforms",
label: "Language Integrations",
link: "language-integrations",
icon: "seti:html",
items: [
{
label: "Platforms",
collapsed: false,
items: [
"platforms/desktop",
"platforms/embedded",
"platforms/mobile",
],
label: "C++ ↗",
link: "https://docs.slint.dev/latest/docs/cpp/",
attrs: { target: "_blank" },
},
{
label: "Language Integrations",
collapsed: false,
items: [
{
label: "C++ ↗",
link: "https://docs.slint.dev/latest/docs/cpp/",
attrs: { target: "_blank" },
},
{
label: "Rust ↗",
link: "https://docs.slint.dev/latest/docs/rust/slint/",
attrs: { target: "_blank" },
},
{
label: "TypeScript ↗",
badge: {
text: "beta",
variant: "caution",
},
link: "https://docs.slint.dev/latest/docs/node/",
attrs: { target: "_blank" },
},
],
label: "Rust ↗",
link: "https://docs.slint.dev/latest/docs/rust/slint/",
attrs: { target: "_blank" },
},
{
label: "Miscellaneous",
collapsed: false,
autogenerate: { directory: "platforms/misc" },
label: "TypeScript ↗",
badge: {
text: "beta",
variant: "caution",
},
link: "https://docs.slint.dev/latest/docs/node/",
attrs: { target: "_blank" },
},
],
},
Expand Down
0 ...t/docs/platforms/misc/backend_linuxkms.md → ...ackends-and-renderers/backend_linuxkms.md
View file
File renamed without changes.
0 ...content/docs/platforms/misc/backend_qt.md → ...uide/backends-and-renderers/backend_qt.md
View file
File renamed without changes.
0 ...tent/docs/platforms/misc/backend_winit.md → ...e/backends-and-renderers/backend_winit.md
View file
File renamed without changes.
0 .../platforms/misc/backends_and_renderers.md → ...s-and-renderers/backends_and_renderers.md
View file
File renamed without changes.
7 changes: 7 additions & 0 deletions docs/astro/src/content/docs/guide/development/accessibility.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
<!-- Copyright © SixtyFPS GmbH <info@slint.dev> ; SPDX-License-Identifier: MIT -->
title: Accessibility
description: Accessibility
---

Todo: Was this for after 1.9 as we have no docs beyond the list of accessibility properties in the common properties?
20 changes: 3 additions & 17 deletions ...rc/content/docs/platforms/misc/recipes.md → ...ocs/guide/development/custom-controls.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
<!-- Copyright © SixtyFPS GmbH <info@slint.dev> ; SPDX-License-Identifier: MIT -->
title: Recipes
description: Recipes
title: Custom Controls
description: Custom Controls
---


# Custom Control Introduction

## A Clickable Button
Expand Down Expand Up @@ -975,18 +976,3 @@ export component SideBarTest inherits Window {
}
```

<!--
more content:
## Input Events
### Keyboard Input
Receive key events, pass them to native code
### Mouse and Touch Input
### Flickable
-->
4 changes: 2 additions & 2 deletions ...nt/docs/guide/development/localization.md → ...nt/docs/guide/development/translations.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
<!-- Copyright © SixtyFPS GmbH <info@slint.dev> ; SPDX-License-Identifier: MIT -->
title: Localization (l10n)
description: Localization
title: Translations
description: Translations
---

<!-- cSpell: ignore msgfmt msgctx msginit poedit Lokalize Transifex -->
Expand Down
46 changes: 0 additions & 46 deletions docs/astro/src/content/docs/guide/language/advanced/container.mdx
View file

This file was deleted.

2 changes: 2 additions & 0 deletions ...ocs/guide/language/advanced/animation.mdx → .../docs/guide/language/coding/animation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,5 @@ is the same as:
animate x { duration: 100ms; easing: ease-out-bounce; }
animate y { duration: 100ms; easing: ease-out-bounce; }
```


Loading

0 comments on commit cbd6f09

Please sign in to comment.