docs: prep repo and docs for OSS release

Author: erlendellefsen

JsonApiToolkit/packages.lock.json

@@ -413,6 +413,18 @@
         "resolved": "4.7.0",
         "contentHash": "ehYW0m9ptxpGWvE4zgqongBVWpSDU/JCFD4K7krxkQwSz/sFQjEXCUqpvencjy6DYDbn7Ig09R8GFffu8TtneQ=="
       }
+    },
+    "net10.0/linux-musl-x64": {
+      "System.Security.Cryptography.Pkcs": {
+        "type": "Transitive",
+        "resolved": "10.0.0",
+        "contentHash": "UPWqLSygJlFerRi9XNIuM0a1VC8gHUIufyP24xQ0sc+XimqUAEcjpOz9DhKpyDjH+5B/wO3RpC0KpkEeDj/ddg=="
+      },
+      "System.Security.Cryptography.ProtectedData": {
+        "type": "Transitive",
+        "resolved": "4.7.0",
+        "contentHash": "ehYW0m9ptxpGWvE4zgqongBVWpSDU/JCFD4K7krxkQwSz/sFQjEXCUqpvencjy6DYDbn7Ig09R8GFffu8TtneQ=="
+      }
     }
   }
 }

README.md

@@ -4,7 +4,7 @@
 </h1>
 
 <p align="center">
-    <em>A .NET toolkit for implementing the JSON:API specification.</em>
+    <em>Build JSON:API endpoints in ASP.NET Core.</em>
 </p>
 <p align="center">
     <a href="https://dotnet.microsoft.com/">
@@ -26,7 +26,7 @@
 
 ## Description
 
-JsonApiToolkit makes ASP.NET Core APIs speak the [JSON:API specification](https://jsonapi.org/). It translates standard query parameters (`filter[]`, `sort`, `include`, `fields[]`, `page[]`) into typed EF Core queries and returns spec-compliant response documents, so your controllers stay short and predictable.
+JsonApiToolkit translates [JSON:API](https://jsonapi.org/) query parameters (`filter[]`, `sort`, `include`, `fields[]`, `page[]`) into typed EF Core queries and shapes responses as spec-compliant documents, so your ASP.NET Core controllers stay short.
 
 ## Installation
 
@@ -47,10 +47,14 @@ Derive controllers from `JsonApiController` and let `JsonApiQueryAsync` handle t
 ```csharp
 public class BooksController : JsonApiController
 {
+    private const string ResourceType = "book";
+
     [HttpGet]
     [AllowedIncludes("author", "publisher")]
-    public Task<IActionResult> GetBooks() =>
-        JsonApiQueryAsync(_dbContext.Books.AsQueryable(), "book");
+    public async Task<IActionResult> GetAllAsync()
+    {
+        return await JsonApiQueryAsync(_dbContext.Books, ResourceType);
+    }
 }
 ```
 

SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in JsonApiToolkit, please report it privately. **Do not open a public issue.**
+
+Use [GitHub private vulnerability reporting](https://github.com/intility/json-api-toolkit/security/advisories/new). If that's unavailable to you, email <security@intility.no>.
+
+Please include:
+
+- A description of the vulnerability and its potential impact
+- Steps to reproduce or a PoC
+- The affected version(s) of JsonApiToolkit
+- Any suggested mitigations

docs/.pages

@@ -1,18 +1,16 @@
 nav:
   - Home:
       - Welcome: index.md
-      - introduction.md
       - getting-started.md
   - Guides:
       - querying.md
       - build-query.md
-      - enhanced-error-handling.md
-      - performance.md
+      - error-handling.md
       - security.md
-      - api-controller-examples.md
-      - debugging.md
-      - upgrade-guide.md
-  - integrations
+      - performance.md
+      - recipes.md
+      - troubleshooting.md
+      - openapi.md
   - api
   - contributing.md
   - changelog.md