Skip to content

Commit

Permalink
spellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
levkk committed Oct 18, 2024
1 parent a15fb57 commit 8f85616
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/docs/controllers/authentication.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -12,14 +14,15 @@ 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

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: "black"
toggle:
icon: material/brightness-4
name: Switch to system preference
Expand All @@ -41,6 +44,3 @@ markdown_extensions:
plugins:
- search
- awesome-pages
# nav:
# - "index.md"
# - "controllers/index.md"

0 comments on commit 8f85616

Please sign in to comment.