Skip to content

Commit

Permalink
lin fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
PGimenez committed Jul 29, 2024
1 parent fddfd42 commit 24f2785
Show file tree
Hide file tree
Showing 19 changed files with 51 additions and 34 deletions.
2 changes: 1 addition & 1 deletion content/1.geniebuilder/docs/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ Genie Builder is a VS Code extension that helps you build Julia web apps 10x fas

The Genie Builder extension is available on the VSCode marketplace. To find it, search for "genie builder" in the Extensions tab in VSCode, and follow the installation instructions in the extension page.

You can also run Genie Builder on JuliaHub following [these instructions](/docs/genie-builder/using-gb-on-juliahub).
You can also run Genie Builder on JuliaHub following [these instructions](/geniebuilder/using-gb-on-juliahub).

6 changes: 3 additions & 3 deletions content/1.geniebuilder/docs/1.quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ After a moment, the button will change to "GB running", and you'll see the new G

<img class="border-gray-300" style="display:block;width:25%;max-width:100%;margin-left:auto;margin-right:auto" src="/assets/docs/gb/newappmenu.png">

Next, create a new app by clicking on the "Create Genie app" button the GENIE tab. You'll be prompted to name your app and enter a path to save it. After a few moments, the app will be created and loaded, with the main window displaying the [visual UI editor](/docs/genie-builder/ui-editor). See the [Troubleshooting](/docs/genie-builder/troubleshooting) page if you're having issues launching Genie Builder.
Next, create a new app by clicking on the "Create Genie app" button the GENIE tab. You'll be prompted to name your app and enter a path to save it. After a few moments, the app will be created and loaded, with the main window displaying the [visual UI editor](/geniebuilder/ui-editor). See the [Troubleshooting](/geniebuilder/troubleshooting) page if you're having issues launching Genie Builder.

Read on to create your first app, or watch the video below for a quick introduction.

Expand Down Expand Up @@ -100,7 +100,7 @@ To make the big numbers appear side by side instead of in a column, select the p

<img class="border-gray-300 border-2" style="display:block;width:70%;max-width:100%;margin-left:auto;margin-right:auto" src="/assets/docs/guides/gb-quickstart/flex.png">

To learn more about the features provided by the visual editor, see its [dedicated documentation](/docs/genie-builder/ui-editor).
To learn more about the features provided by the visual editor, see its [dedicated documentation](/geniebuilder/ui-editor).


## 3. Implement the app's logic
Expand Down Expand Up @@ -241,7 +241,7 @@ app.jl.html

## 4. Deploy the app

You can deploy the app from the JuliaHub projects page as explained [here](/docs/genie-builder/using-gb-on-juliahub). You can also follow [this guide](/docs/guides/deploying-genie-apps) to containerize your app with Docker and deploy it online.
You can deploy the app from the JuliaHub projects page as explained [here](/geniebuilder/using-gb-on-juliahub). You can also follow [this guide](/docs/guides/deploying-genie-apps) to containerize your app with Docker and deploy it online.



Expand Down
2 changes: 1 addition & 1 deletion content/1.geniebuilder/docs/2.Usage-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ When the UI editor is open, it'll be displayed in the main tab of the IDE:

<img class="border-gray-300" style="display:block;width:75%;max-width:100%;margin-left:auto;margin-right:auto" src="/assets/docs/gb/mainwindow.png">

See its [dedicated guide](/docs/genie-builder/ui-editor) for more details about using the UI editor.
See its [dedicated guide](/geniebuilder/ui-editor) for more details about using the UI editor.

## Running Genie Builder

Expand Down
10 changes: 5 additions & 5 deletions content/1.geniebuilder/docs/3.UI-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ As shown in the picture above, the space in the main view is divided into severa
- **No-code canvas**: where you can drag and drop components to build your app's UI.
- **Component library**: a list of components you can add to the canvas.
- **Pages and bindings**: a list of the pages in your app, and the reactive variables that can be bound to UI components.
- [**AI assistant**](/docs/genie-builder/ai-assistant): an assistant that generates code for your UI, and answers questions using the Genie documentation.
- [**AI assistant**](/geniebuilder/ai-assistant): an assistant that generates code for your UI, and answers questions using the Genie documentation.
- **File explorer**: where you can see the files in your workspace, and open new ones to edit.
- **Logs**: a view of the log messages generated by the app.

Moreover, the right sidebar has several sub menus displaying more information and settings:
- [**Component properties**](/docs/genie-builder/ui-editor#component-properties): the properties of the selected component.
- [**Styles**](/docs/genie-builder/ui-editor#styles): the CSS style options of the selected component.
- [**Bindings**](/docs/genie-builder/ui-editor#bindings): the list of reactive variables, with icons displaying their type.
- [**Code**](/docs/genie-builder/ui-editor#code): the source code of the selected component, which can be edited directly.
- [**Component properties**](/geniebuilder/ui-editor#component-properties): the properties of the selected component.
- [**Styles**](/geniebuilder/ui-editor#styles): the CSS style options of the selected component.
- [**Bindings**](/geniebuilder/ui-editor#bindings): the list of reactive variables, with icons displaying their type.
- [**Code**](/geniebuilder/ui-editor#code): the source code of the selected component, which can be edited directly.


<div class="flex flex-wrap">
Expand Down
4 changes: 2 additions & 2 deletions content/1.geniebuilder/docs/5.Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Genie Builder uses `Revise` to handle code reloading in the `app.jl` file. If yo

### App in bugged state

If your app is showing a bug icon, check the terminal for any errors or read through the [logs](https://learn.genieframework.com/docs/genie-builder/usage-guide#debugging-apps).
If your app is showing a bug icon, check the terminal for any errors or read through the [logs](https://learn.genieframework.com/geniebuilder/usage-guide#debugging-apps).

### Importing static assets

Expand All @@ -37,5 +37,5 @@ If you see an error in the REPL similar to "table schema_migrations already exi
There could be several reasons why an app is not starting after loading it in Genie Builder:

- Missing packages: make sure to install all the dependencies with the package manager before adding any imports to `app.jl`.
- Bug in the code: if there are bugs in the code, the app will not run. Check the terminal and the [logs](https://learn.genieframework.com/docs/genie-builder/usage-guide#debugging-apps).
- Bug in the code: if there are bugs in the code, the app will not run. Check the terminal and the [logs](https://learn.genieframework.com/geniebuilder/usage-guide#debugging-apps).
- Long startup: on a first run, setting up the Genie Builder can take a few minutes.
6 changes: 3 additions & 3 deletions content/2.framework/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Genie is a powerful full-stack web framework for the Julia programming language,

Genie Framework has three main components: Genie, Stipple and SearchLight.

**[Genie.jl](/docs/reference/server/introduction)** provides backend and frontend tools, so that you can build **full stack web apps** and APIs around your Julia code.
**[Genie.jl](/framework/genie.jl/docs/introduction)** provides backend and frontend tools, so that you can build **full stack web apps** and APIs around your Julia code.

For **real-time interactivity** and a rich UI, like what's needed in a **dashboard**, **[Stipple.jl](/docs/reference/reactive-ui/introduction)** provides a reactive UI layer.
For **real-time interactivity** and a rich UI, like what's needed in a **dashboard**, **[Stipple.jl](/framework/stipple.jl/docs/introduction)** provides a reactive UI layer.

For **database persistence**, Genie's ORM, **[SearchLight.jl](/docs/reference/database)**, can be added at any time.

Expand All @@ -30,7 +30,7 @@ This will install `Genie.jl`, `Stipple.jl` along with other accessory packages.

To create a basic webpage [Creating web pages](/docs/guides/creating-web-pages) guide.

To build an interactive **dashboard**, check out the [First dashboard](/docs/guides/first-dashboard) guide and the [Component gallery](/docs/reference/reactive-ui/component-gallery).
To build an interactive **dashboard**, check out the [First dashboard](/docs/guides/first-dashboard) guide and the [Component gallery](/framework/stipple.jl/docs/component-gallery).

To build a multipage app, head over to the [Multipage apps](/docs/guides/multipage-apps) guide.

Expand Down
8 changes: 4 additions & 4 deletions content/2.framework/1.guides/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Genie is a powerful full-stack web framework for the Julia programming language,

Genie Framework has three main components: Genie, Stipple, SearchLight and Genie Builder.

**[Genie.jl](/docs/reference/server/introduction)** provides backend and frontend tools, so that you can build **full stack web apps** and APIs around your Julia code.
**[Genie.jl](/framework/genie.jl/docs/introduction)** provides backend and frontend tools, so that you can build **full stack web apps** and APIs around your Julia code.

For **real-time interactivity** and a rich UI, like what's needed in a **dashboard**, **[Stipple.jl](/docs/reference/reactive-ui/introduction)** provides a reactive UI layer.
For **real-time interactivity** and a rich UI, like what's needed in a **dashboard**, **[Stipple.jl](/framework/stipple.jl/docs/introduction)** provides a reactive UI layer.

For **database persistence**, Genie's ORM, **[SearchLight.jl](/docs/reference/database)**, can be added at any time.

Finally, **[Genie Builder](/docs/genie-builder/quick-start)** increases your productivity by providing a way to design your UIs visually with drag-and-drop of components.
Finally, **[Genie Builder](/geniebuilder/quick-start)** increases your productivity by providing a way to design your UIs visually with drag-and-drop of components.


## Getting started
Expand All @@ -31,7 +31,7 @@ This will install `Genie.jl`, `Stipple.jl` along with other accessory packages.

To create a basic webpage [Creating web pages](/docs/guides/creating-web-pages) guide.

To build an interactive **dashboard**, check out the [First dashboard](/docs/guides/first-dashboard) guide and the [Component gallery](/docs/reference/reactive-ui/component-gallery).
To build an interactive **dashboard**, check out the [First dashboard](/docs/guides/first-dashboard) guide and the [Component gallery](/framework/stipple.jl/docs/component-gallery).

To build a multipage app, head over to the [Multipage apps](/docs/guides/multipage-apps) guide.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When run locally during development, Genie apps are in development mode. This me
GENIE_ENV=prod julia --project -e "using GenieFramework; Genie.loadapp(); up(async=false);
```
2. If you're using [configuration files](/docs/reference/server/configuration), edit `config/env/global.jl` and add the following line:
2. If you're using [configuration files](/framework/genie.jl/docs/configuration), edit `config/env/global.jl` and add the following line:
```julia
ENV["GENIE_ENV"] = "prod"
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ end
<h1>Welcome to Genie $name !</h1>
```

To learn more about the types of routes and how to pass parameters to a page, see the [routing](https://learn.genieframework.com/docs/reference/server/routing) section in the reference.
To learn more about the types of routes and how to pass parameters to a page, see the [routing](https://learn.genieframework.com/framework/genie.jl/docs/routing) section in the reference.

### Executing Julia code in a page

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ julia> slider(1:1:1000, :N)
"<q-slider :min=1 v-model=\"N\" :max=1000 :step=1></q-slider>"
```

See the [component gallery](/docs/reference/reactive-ui/component-gallery) and the [API](/docs/api/ui/components/badges) for a complete list of available components.
See the [component gallery](/framework/stipple.jl/docs/component-gallery) and the [API](/docs/api/ui/components/badges) for a complete list of available components.

To incorporate the slider component and the mean display into the UI, add the following code to the `ui` function:
<div style="display: flex; justify-content: space-between; align-items: flex-start;">
Expand Down Expand Up @@ -170,7 +170,7 @@ end

```

Using the `@in`, `@out` and `@onchange` you can implement all kinds of interactivity in an easy manner. To learn more, check out the [Reactivity](/docs/reference/reactive-ui/reactivity) reference.
Using the `@in`, `@out` and `@onchange` you can implement all kinds of interactivity in an easy manner. To learn more, check out the [Reactivity](/framework/stipple.jl/docs/reactivity) reference.

You should now have a working reactive UI! Let's add the histogram plot.

Expand Down Expand Up @@ -223,4 +223,4 @@ This is the final reactive code in `app.jl`:
end
```

And that's it, you've finished your first dashboard! For more details on plotting, see the [Plotting](/docs/reference/reactive-ui/plotting) reference page. Then, you can continue reading the guides to add more features such as [multiple pages](/docs/guides/multipage-apps) or an [API](/docs/guides/creating-an-API).
And that's it, you've finished your first dashboard! For more details on plotting, see the [Plotting](/framework/stipple.jl/docs/plotting) reference page. Then, you can continue reading the guides to add more features such as [multiple pages](/framework/stipple.jl/guides/multipage-apps) or an [API](/framework/genie.jl/guides/creating-an-API).
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: How to add pages with reactive components that enable real-time int

# Multipage apps

There are several possible patterns for apps with reactive pages. For more details on building reactive apps, see the [Your first dashboard](/docs/guides/first-dashboard) guide and the [docs](/docs/reference/reactive-UI).
There are several possible patterns for apps with reactive pages. For more details on building reactive apps, see the [Your first dashboard](/framework/stipple.jl/guides/first-dashboard) guide and the [docs](/framework/stipple.jl/).

### Single app module with multiple pages

Expand Down
2 changes: 1 addition & 1 deletion content/3.tutorials/20.map-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ label: "Plot"

#### PlotlyJS with Genie

[Plotting in Genie](/docs/reference/reactive-ui/plotting) with PlotlyJS is straightforward: just define the trace and layout variables and expose them to the UI with `@out`. For example, the previous scatter plot example would become:
[Plotting in Genie](/framework/stipple.jl/docs/plotting) with PlotlyJS is straightforward: just define the trace and layout variables and expose them to the UI with `@out`. For example, the previous scatter plot example would become:

```julia
@app begin
Expand Down
4 changes: 2 additions & 2 deletions content/3.tutorials/40.CSV-uploader.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ mkpath(FILE_PATH)
end
```

When activated, the handler will move the uploaded file from its temporary location to `FILE_PATH` and notify the user. The `__model__` passed to `notify` is the [reactive model](https://learn.genieframework.com/docs/reference/reactive-ui/reactivity) of the app, which maintains a representation of the reactive elements in the app. We've also added the `upfiles` variable to store the list of uploaded files, which will then be used to populate the file selector. Finally, the `@event` macro defines handlers for the received events.
When activated, the handler will move the uploaded file from its temporary location to `FILE_PATH` and notify the user. The `__model__` passed to `notify` is the [reactive model](https://learn.genieframework.com/framework/stipple.jl/docs/reactivity) of the app, which maintains a representation of the reactive elements in the app. We've also added the `upfiles` variable to store the list of uploaded files, which will then be used to populate the file selector. Finally, the `@event` macro defines handlers for the received events.

With this, you can already run your app to test it as
```julia
Expand Down Expand Up @@ -210,7 +210,7 @@ We've also attached the handler to the `isready` variable, which becomes true wh

### Histogram

After selecting a dataset, we want to plot a histogram of one of its plots every time we make a new selection with the column selector. Genie uses Plotly for plots, which requires a trace to store the data on the plot, and a layout to define the plot's aesthetics. See the [plotting reference](https://learn.genieframework.com/docs/reference/reactive-ui/plotting) for more info.
After selecting a dataset, we want to plot a histogram of one of its plots every time we make a new selection with the column selector. Genie uses Plotly for plots, which requires a trace to store the data on the plot, and a layout to define the plot's aesthetics. See the [plotting reference](https://learn.genieframework.com/framework/stipple.jl/docs/plotting) for more info.

Add the trace and layout via reactive variables as:
```julia
Expand Down
2 changes: 1 addition & 1 deletion content/3.tutorials/50.german-credits-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ To show the number badges in the UI, assign each variable to the Text Binding fi
#### Number of credits by age plot

::alert{type="warning"}
This tutorial uses `PlotData` objects for plotting. The new recommended way is to directly use PlotlyJS traces as explained [here](https://learn.genieframework.com/docs/reference/reactive-ui/plotting).
This tutorial uses `PlotData` objects for plotting. The new recommended way is to directly use PlotlyJS traces as explained [here](https://learn.genieframework.com/framework/stipple.jl/docs/plotting).
::

We'll plot the credits by age with a bar plot indexed by the age ranges in 10 year increments. For this, you'll need:
Expand Down
2 changes: 1 addition & 1 deletion content/3.tutorials/60.iris-clustering-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ type accepted by the plotting functions in the UI code we’ll write
later.

::alert{type="warning"}
This tutorial uses `PlotData` objects for plotting. The new recommended way is to directly use PlotlyJS traces as explained [here](https://learn.genieframework.com/docs/reference/reactive-ui/plotting). You can find the updated code for this tutorial [here](https://github.com/BuiltWithGenie/IrisClustering)
This tutorial uses `PlotData` objects for plotting. The new recommended way is to directly use PlotlyJS traces as explained [here](https://learn.genieframework.com/framework/stipple.jl/docs/plotting). You can find the updated code for this tutorial [here](https://github.com/BuiltWithGenie/IrisClustering)
::

Now that the dashboard logic is implemented, we just need to add two
Expand Down
2 changes: 1 addition & 1 deletion content/6.component-gallery/0.index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Changelog
navigation: true
redirect: /docs/reference/reactive-ui/component-gallery
redirect: /framework/stipple.jl/docs/component-gallery
layout: default
---

2 changes: 1 addition & 1 deletion content/6.component-gallery/_dir.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ title: "Component gallery"
icon: ph:slideshow
layout: default
navigation: true
redirect: /docs/reference/reactive-ui/component-gallery
redirect: /framework/stipple.jl/docs/component-gallery
2 changes: 1 addition & 1 deletion content/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ sections:
icon: i-heroicons-code-bracket-square
links:
- label: Read the docs
to: "https://learn.genieframework.com/docs/reference/server/introduction"
to: "https://learn.genieframework.com/framework/genie.jl/docs/introduction"
target: _blank
color: primary
icon: i-heroicons-arrow-right-20-solid
Expand Down
19 changes: 18 additions & 1 deletion nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,22 @@ export default defineNuxtConfig({
}
},

compatibilityDate: '2024-07-11'
compatibilityDate: '2024-07-11',

routeRules: {
// Redirects legacy urls
'/docs/reference/reactive-ui/**': { redirect: '/framework/stipple.jl/docs/**' },
'/docs/reference/reactive-ui/introduction': { redirect: '/framework/stipple.jl/docs/' },
'/docs/reference/reactive-ui': { redirect: '/framework/stipple.jl/docs/' },
'/docs/examples': { redirect: '/framework/stipple.jl/recipes/' },
'/docs/reference/server/introduction': { redirect: '/framework/genie.jl/docs/' },
'/docs/reference/server/**': { redirect: '/framework/genie.jl/docs/**' },
'/docs/reference/server': { redirect: '/framework/genie.jl/docs/' },
'/docs/reference/database/introduction': { redirect: '/framework/searchlight.jl/docs/' },
'/docs/reference/database/**': { redirect: '/framework/searchlight.jl/docs/**' },
'/docs/reference/database': { redirect: '/framework/searchlight.jl/docs/' },
'/docs/genie-builder/introduction': { redirect: '/geniebuilder/' },
'/docs/genie-builder/**': { redirect: '/geniebuilder/docs/**' },
'/docs/genie-builder': { redirect: '/geniebuilder' }
}
})

0 comments on commit 24f2785

Please sign in to comment.