diff --git a/.castor/docs/README.md b/.castor/docs/README.md index 8e974eb..dd30dca 100644 --- 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) \ No newline at end of file +- [Introduction](intro.md) +- [Why this Library?](why.md) +- [Guides](guides.md) +- [Best Practices](best-practices.md) +- [FAQ](faq.md) \ No newline at end of file diff --git a/.castor/docs/best-practices.md b/.castor/docs/best-practices.md new file mode 100644 index 0000000..9420178 --- /dev/null +++ b/.castor/docs/best-practices.md @@ -0,0 +1,2 @@ +Best Practices +============= \ No newline at end of file diff --git a/.castor/docs/faq.md b/.castor/docs/faq.md new file mode 100644 index 0000000..e69de29 diff --git a/.castor/docs/guides.md b/.castor/docs/guides.md new file mode 100644 index 0000000..e69de29 diff --git a/.castor/docs/intro.md b/.castor/docs/intro.md index 27af506..cce87db 100644 --- 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 index 2857953..b228847 100644 --- 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" } ] } \ No newline at end of file diff --git a/.castor/docs/why.md b/.castor/docs/why.md new file mode 100644 index 0000000..e69de29