From 05fa8a5ae297061185a49e0c2bd203dfc6e18e3d Mon Sep 17 00:00:00 2001 From: Valerio Ageno <51341197+Valerioageno@users.noreply.github.com> Date: Sat, 30 Nov 2024 14:16:10 +0100 Subject: [PATCH] feat: update docs and readme repo links (#180) --- CONTRIBUTING.md | 10 +-- README.md | 10 +-- .../src/components/edit-page/edit-page.tsx | 2 +- .../src/components/navbar/actions.tsx | 2 +- .../src/routes/documentation/index.mdx | 4 +- examples/tuono-app/src/routes/index.tsx | 76 +++++++++---------- packages/fs-router-vite-plugin/README.md | 4 +- packages/lazy-fn-vite-plugin/README.md | 4 +- packages/router/README.md | 2 +- 9 files changed, 57 insertions(+), 57 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc80a08..f6bbab5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ -![](https://github.com/Valerioageno/tuono/actions/workflows/rust.yml/badge.svg) -![](https://github.com/Valerioageno/tuono/actions/workflows/typescript.yml/badge.svg) +![](https://github.com/tuono-labs/tuono/actions/workflows/rust.yml/badge.svg) +![](https://github.com/tuono-labs/tuono/actions/workflows/typescript.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) # How to Contribute to Tuono @@ -7,15 +7,15 @@ ## Contributions Any feature contribution or suggestion is strongly appreciated. -Since the current project size, there isn't yet a defined way to start a discussion. Consider [opening a new issue](https://github.com/Valerioageno/tuono/issues/new/choose) +Since the current project size, there isn't yet a defined way to start a discussion. Consider [opening a new issue](https://github.com/tuono-labs/tuono/issues/new/choose) or to reach me using my email address, [valerioageno@yahoo.it](mailto:valerioageno@ahoo.it). I'm also available on Twitter (X); DM @valerioageno. ## Bugs **Did you find a bug?** -- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/Valerioageno/tuono/issues). -- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Valerioageno/tuono/issues/new/choose). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. +- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/tuono-labs/tuono/issues). +- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/tuono-labs/tuono/issues/new/choose). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. **Did you write a patch that fixes a bug?** diff --git a/README.md b/README.md index b81c8bb2..b1e00b57 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ # Tuono - + -![](https://github.com/Valerioageno/tuono/actions/workflows/rust.yml/badge.svg) -![](https://github.com/Valerioageno/tuono/actions/workflows/typescript.yml/badge.svg) +![](https://github.com/tuono-labs/tuono/actions/workflows/rust.yml/badge.svg) +![](https://github.com/tuono-labs/tuono/actions/workflows/typescript.yml/badge.svg) **Tuono is a full-stack web framework for building React applications using Rust as the backend with a strong focus on usability and performance.** @@ -48,7 +48,7 @@ by Tuono based on the files defined within the `./src/routes` directory. The Tuono API tries to stick as much as possible to the Next.js one (or at least takes a huge inspiration from it). The major difference is the backend system. While Next.js relies entirely on Node/Deno/Bun, Tuono runs the server without any intermediary runtime. This enables impressive performance improvements -(check the benchmarks [here](https://github.com/Valerioageno/tuono/tree/main/benches)). +(check the benchmarks [here](https://github.com/tuono-labs/tuono/tree/main/benches)). ## Getting started @@ -61,7 +61,7 @@ Then run `cargo install tuono`. 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](https://github.com/Valerioageno/tuono/tree/main/examples) folder). +[examples](https://github.com/tuono-labs/tuono/tree/main/examples) folder). Then, to run the local development environment, install the JS dependencies (`npm install`) and run inside the project folder `tuono dev` diff --git a/apps/documentation/src/components/edit-page/edit-page.tsx b/apps/documentation/src/components/edit-page/edit-page.tsx index 80b6959a..e285f3b1 100644 --- a/apps/documentation/src/components/edit-page/edit-page.tsx +++ b/apps/documentation/src/components/edit-page/edit-page.tsx @@ -4,7 +4,7 @@ import { IconEdit } from '@tabler/icons-react' import { useRouter } from 'tuono' const GITHUB_URL = - 'https://github.com/Valerioageno/tuono/tree/main/apps/documentation/src/routes' + 'https://github.com/tuono-labs/tuono/tree/main/apps/documentation/src/routes' export default function EditPage(): JSX.Element { const { pathname } = useRouter() diff --git a/apps/documentation/src/components/navbar/actions.tsx b/apps/documentation/src/components/navbar/actions.tsx index cace620b..3a00fdce 100644 --- a/apps/documentation/src/components/navbar/actions.tsx +++ b/apps/documentation/src/components/navbar/actions.tsx @@ -27,7 +27,7 @@ export default function Actions(): JSX.Element { variant="default" size="lg" aria-label="Check the project on github" - href="https://github.com/Valerioageno/tuono" + href="https://github.com/tuono-labs/tuono" target="_blank" component="a" > diff --git a/apps/documentation/src/routes/documentation/index.mdx b/apps/documentation/src/routes/documentation/index.mdx index 30484cfd..73218963 100644 --- a/apps/documentation/src/routes/documentation/index.mdx +++ b/apps/documentation/src/routes/documentation/index.mdx @@ -36,7 +36,7 @@ Tuono addresses the following two limits: #### NodeJs/Deno/Bun are the only runtimes that allow a React app to be server-side rendered (SSR)? (no) -Tuono is the first full-stack React framework with the server side written in Rust (check the [ssr-rs](https://github.com/Valerioageno/ssr-rs) crate). +Tuono is the first full-stack React framework with the server side written in Rust (check the [ssr-rs](https://github.com/tuono-labs/ssr-rs) crate). Because of this, Tuono is extremely fast, and the requests are handled by a multithreaded Rust server. React is still React - it is just superpowered. @@ -51,4 +51,4 @@ The routing is handled by Tuono based on the files defined within the `./src/rou The Tuono API tries to stick as much as possible to the Next.js one (or at least takes a huge inspiration from it). The major difference is the backend system. While Next.js relies entirely on Node/Deno/Bun, Tuono runs the server without any intermediary runtime. This enables impressive performance improvements -(check the benchmarks [here](https://github.com/Valerioageno/tuono/tree/main/benches)). +(check the benchmarks [here](https://github.com/tuono-labs/tuono/tree/main/benches)). diff --git a/examples/tuono-app/src/routes/index.tsx b/examples/tuono-app/src/routes/index.tsx index faa78cf7..719f8ea6 100644 --- a/examples/tuono-app/src/routes/index.tsx +++ b/examples/tuono-app/src/routes/index.tsx @@ -2,47 +2,47 @@ import type { JSX } from 'react' import type { TuonoProps } from 'tuono' interface IndexProps { - subtitle: string + subtitle: string } export default function IndexPage({ - data, - isLoading, + data, + isLoading, }: TuonoProps): JSX.Element { - if (isLoading) { - return

Loading...

- } + if (isLoading) { + return

Loading...

+ } - return ( - <> -
- - Crates - - - Npm - -
-
-

- TUONO -

-
- - -
-
-
-

{data?.subtitle}

- - Github - -
- - ) + return ( + <> +
+ + Crates + + + Npm + +
+
+

+ TUONO +

+
+ + +
+
+
+

{data?.subtitle}

+ + Github + +
+ + ) } diff --git a/packages/fs-router-vite-plugin/README.md b/packages/fs-router-vite-plugin/README.md index 3a846741..c859ca7d 100644 --- a/packages/fs-router-vite-plugin/README.md +++ b/packages/fs-router-vite-plugin/README.md @@ -1,10 +1,10 @@ # tuono-fs-router-vite-plugin -This is a vite plugin for [tuono](https://github.com/Valerioageno/tuono). +This is a vite plugin for [tuono](https://github.com/tuono-labs/tuono). This package specifically handles the file system based routing. -Check [tuono](https://github.com/Valerioageno/tuono) for more. +Check [tuono](https://github.com/tuono-labs/tuono) for more. ## Credits diff --git a/packages/lazy-fn-vite-plugin/README.md b/packages/lazy-fn-vite-plugin/README.md index 35f74f83..76135f94 100644 --- a/packages/lazy-fn-vite-plugin/README.md +++ b/packages/lazy-fn-vite-plugin/README.md @@ -1,8 +1,8 @@ # tuono-lazy-fn-vite-plugin -This is a vite plugin for [tuono](https://github.com/Valerioageno/tuono). +This is a vite plugin for [tuono](https://github.com/tuono-labs/tuono). This package specifically handles the transpiling of the `dynamic` function allowing custom componenents to be lazy loaded but also server side rendered. -Check [tuono](https://github.com/Valerioageno/tuono) for more. +Check [tuono](https://github.com/tuono-labs/tuono) for more. diff --git a/packages/router/README.md b/packages/router/README.md index 86ab47c5..cdfdf463 100644 --- a/packages/router/README.md +++ b/packages/router/README.md @@ -2,4 +2,4 @@ This package holds the logic related to the client/server react routing. -Check [tuono](https://github.com/Valerioageno/tuono) for more. +Check [tuono](https://github.com/tuono-labs/tuono) for more.