[Seaography] Docs

Author: tyt2y3

Seaography/docs/06-access-control/02-schema-restrictions.md

@@ -12,7 +12,13 @@ pub fn schema_builder(..) -> SchemaBuilder {
 }
 ```
 
-You can register entities individually:
+The `register_entity_modules` function actually expands to:
+
+```rust
+seaography::register_entities!(builder, [actor, address, ..]);
+```
+
+You can remove it and register entities individually instead:
 
 ```rust
 seaography::register_entity!(builder, actor);

Seaography/docs/06-access-control/03-guards.md

@@ -38,11 +38,11 @@ impl LifecycleHooksInterface for AccessControlGuard {
         action: OperationType, // ⬅ Read, Create, Update, Delete
     ) -> GuardAction {
         match (entity, field, action) {
-            // block all access on a field
+            // ⬇ block all access on a field
             ("Language", "lastUpdate", _) => GuardAction::Block(None),
-            // block only update on a field
+            // ⬇ block only update on a field
             ("Language", "name", OperationType::Update) => GuardAction::Block(None),
-            // custom logic based on context and object value
+            // ⬇ custom logic based on context and object value
             ("Actor", _, _) => {
                 let permissions = ctx.data::<Permissions>().unwrap();
                 //  ⬆ extract permission from context

Seaography/docs/06-access-control/04-filters.md

@@ -28,4 +28,4 @@ impl LifecycleHooksInterface for AccessControlHook {
 }
 ```
 
-This method is called on Read, Create, Update, Delete. So you can apply conditional logic based on operation performed and other information from context.
+This method is called on Read, Create, Update, Delete. So you can apply conditional logic based on operation performed and other contextual information.

Seaography/docs/06-access-control/05-rbac.md

@@ -12,7 +12,7 @@ version = "~2.0.0-rc" # seaography version
 features = ["rbac"]
 ```
 
-After connecting to the database, you should initialize RBAC for the connection before creating the schema:
+After connecting to the database, you should initialize RBAC rules for the connection before creating the schema:
 
 ```rust
 let db = Database::connect(db_url).await?;
@@ -25,7 +25,7 @@ In the GraphQL handler, you have to inject a `UserContext`:
 ```rust
 async fn graphql_handler(..) -> Result<..> {
     let mut req = req.into_inner();
-    req = req.data(seaography::UserContext { user_id }); // ⬅ this user id is used in RBAC
+    req = req.data(seaography::UserContext { user_id }); // ⬅ this user id is used by RBAC engine
     schema.execute(req).await.into()
 }
 ```

Seaography/docs/06-access-control/06-considerations.md

@@ -49,4 +49,4 @@ By layering these approaches, you can tailor Seaography's authorization model to
 
 ## Professional Support
 
-If you need technical advice and support, you’re welcome to [consult with SeaQL.org](mailto:[email protected]). Our team can help you adopt and unlock the full potential of the Rust + SeaQL ecosystem by providing expert consulting to support your software development.
+If you need technical advice and support, you're welcome to [consult with SeaQL.org](mailto:[email protected]). Our team can help you adopt and unlock the full potential of the Rust + SeaQL ecosystem by providing expert consulting to support your software development.

Seaography/docusaurus.config.js

@@ -8,8 +8,8 @@ function getNextMinorVersionName() {
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'Seaography 🧭 A GraphQL framework for SeaORM',
-  tagline: '🧭 Seaography is a GraphQL framework for SeaORM',
+  title: 'Seaography 🧭 A GraphQL framework for Rust',
+  tagline: '🧭 Seaography is a GraphQL framework for Rust',
   url: 'https://www.sea-ql.org',
   baseUrl: '/Seaography/',
   onBrokenLinks: 'throw',