From d8af404e965a04f03f1f2c26b9097120dd02750d Mon Sep 17 00:00:00 2001 From: Joshua Estes Date: Tue, 31 Oct 2023 17:02:52 -0400 Subject: [PATCH] updates --- .github/CODEOWNERS | 4 +++- docs/contracts/index.md | 14 ++++++++++++++ mkdocs.yml | 6 ++++-- 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 docs/contracts/index.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5bee2dbd..8fa1a3b0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,6 @@ -# Packages +/.github @JoshuaEstes +/tools @JoshuaEstes +/docs @JoshuaEstes /src/SonsOfPHP/Bard @JoshuaEstes /src/SonsOfPHP/Bridge/Doctrine/EventSourcing @JoshuaEstes /src/SonsOfPHP/Bridge/Doctrine/FeatureToggle @JoshuaEstes diff --git a/docs/contracts/index.md b/docs/contracts/index.md new file mode 100644 index 00000000..c499e374 --- /dev/null +++ b/docs/contracts/index.md @@ -0,0 +1,14 @@ +--- +title: Contracts +--- + +# Contracts + +Contracts are interfaces that can be reusable across multiple different +libraries and projects. The actual implementation of the interfaces is left up +to you. + +The interfaces also enhance existing PSRs. + +Whenever possible, the components and projects created by Sons of PHP will +implement these interfaces. diff --git a/mkdocs.yml b/mkdocs.yml index 5ddf8400..1910de7f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,6 +55,8 @@ nav: - Getting Help: getting-help.md - Code of Conduct: code-of-conduct.md - Security Policy: security.md + - Bard: + - bard/index.md - Components: - components/index.md - Clock: components/clock/index.md @@ -95,5 +97,5 @@ nav: - Operators: components/money/operators.md - Queries: components/money/queries.md - Version: components/version/index.md - - Bard: - - bard/index.md + - Contracts: + - contracts/index.md