diff --git a/apps/documentation/src/routes/documentation/contributing.mdx b/apps/documentation/src/routes/documentation/contributing.mdx index 56bdaccc..c286a060 100644 --- a/apps/documentation/src/routes/documentation/contributing.mdx +++ b/apps/documentation/src/routes/documentation/contributing.mdx @@ -7,7 +7,7 @@ import { Head } from 'tuono' import Breadcrumbs, { Element } from '../../components/breadcrumbs' - + # Contributing @@ -25,26 +25,24 @@ The `tuono` project can mostly be split by the following sub-domains: - The react frontend - The documentation website (which is written with tuono 🚀) -To check what are the knowledge requirement for each domain check the +To check what are the knowledge requirement for each domain check the [requirements](/documentation/contributing?#requirements) section below. -Currently I'm keeping a private dashboard to prioritize new features and bug fixes but if you +Currently I'm keeping a private dashboard to prioritize new features and bug fixes but if you want to propose something please open a new issue on github or reach me using -my email address [valerioageno@yahoo.it](mailto:valerioageno@yahoo.it). I'm also available +my email address [valerioageno@yahoo.it](mailto:valerioageno@yahoo.it). I'm also available on twitter (X) DMs `@valerioageno`, [linkedin](https://www.linkedin.com/in/valerioageno) and discord `@__v__v__`. ## Requirements It's not strictly required to know both React (& typescript) and Rust (even though it -would be a great nice to have). +would be a great nice to have). Without taking into account specific cases we can mostly split the domain requirements by: - The `CLI` needs Rust knowledge (even though a couple of scenario might need also Typescript) - The Backend needs just `Rust` - The Frontend needs just `React` & `Typescript` -- The documentation website needs just `React` & `Typescript` (or even less since most of the -code is markdown). - - +- The documentation website needs just `React` & `Typescript` (or even less since most of the + code is markdown). diff --git a/apps/documentation/src/routes/documentation/getting-started.mdx b/apps/documentation/src/routes/documentation/getting-started.mdx index 3a3989b2..0def2ef9 100644 --- a/apps/documentation/src/routes/documentation/getting-started.mdx +++ b/apps/documentation/src/routes/documentation/getting-started.mdx @@ -7,22 +7,21 @@ import { Head } from 'tuono' import Breadcrumbs, { Element } from '../../components/breadcrumbs' - + # Getting started - -Tuono is the CLI that provides all the needed commands to handle the fullstack project. +Tuono is the CLI that provides all the needed commands to handle the fullstack project. > ☝️ Check the [installation](/documentation/installation) page if you haven't installed the -`tuono` CLI yet. +> `tuono` CLI yet. To list all the available commands run `tuono -h`. To create a new project run `tuono new [NAME]` (optionally you can pass the --template (or -t) flag - check the examples folder). -Then to run the local development environment run inside the project folder `tuono dev` +Then to run the local development environment run inside the project folder `tuono dev` Finally when the project will be ready to be deployed just run `tuono build` to create the final React assets and to set the server project in the production mode. diff --git a/apps/documentation/src/routes/documentation/index.mdx b/apps/documentation/src/routes/documentation/index.mdx index a33de56c..8a6631ef 100644 --- a/apps/documentation/src/routes/documentation/index.mdx +++ b/apps/documentation/src/routes/documentation/index.mdx @@ -6,8 +6,7 @@ import { Head } from 'tuono' import Breadcrumbs from '../../components/breadcrumbs' - - + # Tuono @@ -20,18 +19,18 @@ Tuono (Italian word for "thunder", pronounced /2 Oh No/). Why Tuono? Just a bada **NodeJs/Deno/Bun are the only runtimes that allow a React app to be fullstack right? (no)** -Tuono is a fullstack React framework with the server side written in Rust. -Because of this Tuono is extremely fast and the requests are handled by multithreaded Rust server. +Tuono is a fullstack React framework with the server side written in Rust. +Because of this Tuono is extremely fast and the requests are handled by multithreaded Rust server. React is still React - it is just superpowered. **Rust is an hard language then writing server side code is hard as well right? (no again)** -Tuono provides a collection of utilities to handle the server side code seamlessly with +Tuono provides a collection of utilities to handle the server side code seamlessly with the React code. Each server side route is managed with a separate file alongside the React route. The routing is handled by Tuono based on the files defined within the `./src/routes` directory. +## Features -## Features Some of its features include: - 🟦 Full typescript support @@ -40,11 +39,10 @@ Some of its features include: - 🍭 SCSS/CSS modules - 🧬 Server Side Rendering - 🧵 Multi thread backend -- ⌨️ MDX support -- ⚙️ Build optimizations -- Custom APIs* -- Image optimization* -- Server streamed content* - -> *development in progress +- ⌨️ MDX support +- ⚙️ Build optimizations +- Custom APIs\* +- Image optimization\* +- Server streamed content\* +> \*development in progress diff --git a/apps/documentation/src/routes/documentation/installation.mdx b/apps/documentation/src/routes/documentation/installation.mdx index f3727f5d..6e89f204 100644 --- a/apps/documentation/src/routes/documentation/installation.mdx +++ b/apps/documentation/src/routes/documentation/installation.mdx @@ -6,7 +6,7 @@ import Breadcrumbs, { Element } from '../../components/breadcrumbs' - + # Installation diff --git a/apps/documentation/src/routes/documentation/routing/index.mdx b/apps/documentation/src/routes/documentation/routing/index.mdx index 9a3656ab..8761188d 100644 --- a/apps/documentation/src/routes/documentation/routing/index.mdx +++ b/apps/documentation/src/routes/documentation/routing/index.mdx @@ -7,7 +7,7 @@ import { Head } from 'tuono' import Breadcrumbs, { Element } from '../../../components/breadcrumbs' - + # Routing index diff --git a/apps/documentation/src/routes/documentation/routing/intro.mdx b/apps/documentation/src/routes/documentation/routing/intro.mdx index a1512633..7b830fc5 100644 --- a/apps/documentation/src/routes/documentation/routing/intro.mdx +++ b/apps/documentation/src/routes/documentation/routing/intro.mdx @@ -7,8 +7,8 @@ import { Head } from 'tuono' import Breadcrumbs, { Element } from '../../../components/breadcrumbs' - - + + # Project structure diff --git a/apps/documentation/src/routes/documentation/tutorial/intro.mdx b/apps/documentation/src/routes/documentation/tutorial/intro.mdx index 5bd1ae04..e0c82c44 100644 --- a/apps/documentation/src/routes/documentation/tutorial/intro.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/intro.mdx @@ -7,7 +7,7 @@ import { Head } from 'tuono' import Breadcrumbs, { Element } from '../../../components/breadcrumbs' - + # Tutorial @@ -15,5 +15,3 @@ import Breadcrumbs, { Element } from '../../../components/breadcrumbs' You can find the tutorial [here](https://github.com/Valerioageno/tuono/blob/main/docs/tutorial.md). Other tasks have the priority right now. The tutorial will be ported here as soon as possible. - -