chore: documentation

castor-labs · Oct 6, 2022 · bdca391 · bdca391
1 parent dc84059
commit bdca391
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 3 deletions.
diff --git a/.castor/docs/README.md b/.castor/docs/README.md
@@ -2,4 +2,8 @@
 
 Context passing abstraction for modern PHP projects, inspired in [Golang's `context` package](https://pkg.go.dev/context).
 
-- [Introduction](intro.md)
+- [Introduction](intro.md)
+- [Why this Library?](why.md)
+- [Guides](guides.md)
+- [Best Practices](best-practices.md)
+- [FAQ](faq.md)
diff --git a/.castor/docs/best-practices.md b/.castor/docs/best-practices.md
@@ -0,0 +1,2 @@
+Best Practices
+=============
diff --git a/.castor/docs/faq.md b/.castor/docs/faq.md
diff --git a/.castor/docs/guides.md b/.castor/docs/guides.md
diff --git a/.castor/docs/intro.md b/.castor/docs/intro.md
@@ -1,6 +1,8 @@
 # Introduction
 
-Context passing abstraction for modern PHP projects, inspired in [Golang's `context` package](https://pkg.go.dev/context).
+Context is an abstraction for passing request-scoped values down the call stack of an application.
+
+The public api is inspired in [Golang's `context` package](https://pkg.go.dev/context).
 
 ## Installation
 

diff --git a/.castor/docs/meta.json b/.castor/docs/meta.json
@@ -1,10 +1,26 @@
 {
   "title": "Castor Context",
-  "priority": 10,
+  "priority": 1000,
   "pages": [
     {
       "name": "Introduction",
       "file" : "intro.md"
+    },
+    {
+      "name": "Why this Library?",
+      "file": "why.md"
+    },
+    {
+      "name": "Guides",
+      "file": "guides.md"
+    },
+    {
+      "name": "Best Practices",
+      "file": "best-practices.md"
+    },
+    {
+      "name": "FAQ",
+      "file": "faq.md"
     }
   ]
 }
diff --git a/.castor/docs/why.md b/.castor/docs/why.md