From 8f85616e49b8bb6c41e67ffdcd8906ef5779d556 Mon Sep 17 00:00:00 2001 From: Lev Kokotov Date: Fri, 18 Oct 2024 01:04:49 -0700 Subject: [PATCH] spellcheck --- docs/docs/controllers/authentication.md | 2 +- docs/docs/encryption.md | 2 +- docs/docs/index.md | 2 +- docs/mkdocs.yml | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/docs/controllers/authentication.md b/docs/docs/controllers/authentication.md index 12e1cfd3..588d1e3c 100644 --- a/docs/docs/controllers/authentication.md +++ b/docs/docs/controllers/authentication.md @@ -1,6 +1,6 @@ # Authentication -Rwf has multiple authentication and authorization mechanisms. Different kinds of authenitcation require their own kinds of user-supplied credentials. The most commonly used mechanism is [Session](../sessions) authentication, which has built-in methods for easy use in [controllers](../). +Rwf has multiple authentication and authorization mechanisms. Different kinds of authentication require their own kinds of user-supplied credentials. The most commonly used mechanism is [Session](../sessions) authentication, which has built-in methods for easy use in [controllers](../). ## Session authentication diff --git a/docs/docs/encryption.md b/docs/docs/encryption.md index 4b2df2b9..f4d181a9 100644 --- a/docs/docs/encryption.md +++ b/docs/docs/encryption.md @@ -21,7 +21,7 @@ let data = serde_json::to_vec(&data).unwrap(); let encrypted = encrypt(&data).unwrap(); ``` -Any kind of data can be encrypted, as long as it's serializable to an array of bytes. Serialization typically be achieved by using [`serde`](https://docs.rs/serde/latest/serde/) or manually. +Any kind of data can be encrypted, as long as it's serializable to an array of bytes. Serialization can typically be achieved by using [`serde`](https://docs.rs/serde/latest/serde/). Encryption produces a base64-encoded UTF-8 string. You can save this string in the database or send it via an insecure medium like email. diff --git a/docs/docs/index.md b/docs/docs/index.md index badbb63e..09fdeb0c 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,6 +1,6 @@ # Getting started -Rust Web Framework (Rwf for short) is set of libraries and tools to build web applications using the Rust programming langauge. It aims to be comprehensive, by providing all features +Rust Web Framework (Rwf for short) is set of libraries and tools to build web applications using the Rust programming language. It aims to be comprehensive, by providing all features for you to build modern, fast, and secure web apps, out of the box. Rwf has very few dependencies, and is easy to install and use within new or existing Rust applications. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0c257f64..f3b6833e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,6 @@ site_name: Rust Web Framework +repo_url: "https://github.com/levkk/rwf" +site_description: "Rust Web Framework - A comprehensive framework for building web applications with Rust" theme: name: material features: @@ -12,7 +14,7 @@ theme: # Palette toggle for light mode - media: "(prefers-color-scheme: light)" scheme: default - + primary: "white" toggle: icon: material/brightness-7 name: Switch to dark mode @@ -20,6 +22,7 @@ theme: # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate + primary: "black" toggle: icon: material/brightness-4 name: Switch to system preference @@ -41,6 +44,3 @@ markdown_extensions: plugins: - search - awesome-pages -# nav: -# - "index.md" -# - "controllers/index.md"