diff --git a/docs/examples/discord_permissions.md b/docs/examples/discord_permissions.md index 9b8d216..2c78b24 100644 --- a/docs/examples/discord_permissions.md +++ b/docs/examples/discord_permissions.md @@ -1,3 +1,7 @@ +--- +description: How to create a discord server like authorization system using scopie. +--- + # Discord Permissions Discord users role based authorization for server administration. diff --git a/docs/examples/github_token.md b/docs/examples/github_token.md index 25b3540..eda79be 100644 --- a/docs/examples/github_token.md +++ b/docs/examples/github_token.md @@ -1,3 +1,7 @@ +--- +description: How to create a github like authorization system using scopie. +--- + # GitHub Access Tokens If you ever needed to create an [access token for GitHub](https://github.com/settings/tokens/new) diff --git a/docs/examples/index.md b/docs/examples/index.md index e5cbc90..60dc011 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,3 +1,7 @@ +--- +description: Different styles of authorization systems built around scopie. +--- + # Examples Scope and rules for sample projects. diff --git a/docs/implementations.md b/docs/implementations.md index bd9108b..224057a 100644 --- a/docs/implementations.md +++ b/docs/implementations.md @@ -2,6 +2,7 @@ hide: - navigation - toc +title: Scopie language implementations --- # Official Implementations diff --git a/docs/specification/bnf.md b/docs/specification/bnf.md index 20241e8..472ae6b 100644 --- a/docs/specification/bnf.md +++ b/docs/specification/bnf.md @@ -1,3 +1,7 @@ +--- +description: Scopie in BNF syntax +--- + # BNF Notation [Backus Naur Form](https://www.geeksforgeeks.org/bnf-notation-in-compiler-design/) notation of the scopie parsing rules. diff --git a/docs/specification/errors.md b/docs/specification/errors.md index 8212896..b72bf8c 100644 --- a/docs/specification/errors.md +++ b/docs/specification/errors.md @@ -1,3 +1,7 @@ +--- +description: Explanation and list of all scopie error codes. +--- + # Errors When validating a scope or trying to process a scope or rule that has an incorrect format we return or throw errors. diff --git a/docs/specification/functions.md b/docs/specification/functions.md index f3de6f1..80aeae8 100644 --- a/docs/specification/functions.md +++ b/docs/specification/functions.md @@ -1,3 +1,7 @@ +--- +description: What functions are defined by scopie. +--- + # Functions Scopie is designed to work in any language and in virtually any system that can use authorization. diff --git a/docs/specification/logic.md b/docs/specification/logic.md index 78bde15..7df4a40 100644 --- a/docs/specification/logic.md +++ b/docs/specification/logic.md @@ -1,3 +1,7 @@ +--- +description: Definitions and reasonings behind some scopie edge cases. +--- + # Allow rules Scopie flow works as a nested for loop iterating over the actor rules and action scopes. diff --git a/mkdocs.yml b/mkdocs.yml index fb4ab9c..473df67 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,6 +43,7 @@ theme: repo: simple/github plugins: - search + - social markdown_extensions: - pymdownx.highlight: anchor_linenums: true diff --git a/requirements.txt b/requirements.txt index 8647f08..3480121 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,28 +1,37 @@ -Babel==2.16.0 -certifi==2024.8.30 -charset-normalizer==3.4.0 +Babel==2.14.0 +cairocffi==1.7.1 +CairoSVG==2.7.1 +certifi==2024.2.2 +cffi==1.17.1 +charset-normalizer==3.3.2 click==8.1.7 colorama==0.4.6 +cssselect2==0.7.0 +defusedxml==0.7.1 ghp-import==2.1.0 -idna==3.10 -Jinja2==3.1.4 -Markdown==3.7 -MarkupSafe==3.0.2 +idna==3.6 +Jinja2==3.1.3 +Markdown==3.6 +MarkupSafe==2.1.5 mergedeep==1.3.4 -mkdocs==1.6.1 -mkdocs-material==9.5.46 +mkdocs==1.5.3 +mkdocs-material==9.5.14 mkdocs-material-extensions==1.3.1 -packaging==24.2 -paginate==0.5.7 +packaging==24.0 +paginate==0.5.6 pathspec==0.12.1 -platformdirs==4.3.6 -Pygments==2.18.0 -pymdown-extensions==10.12 +pillow==10.4.0 +platformdirs==4.2.0 +pycparser==2.22 +Pygments==2.17.2 +pymdown-extensions==10.7.1 python-dateutil==2.9.0.post0 -PyYAML==6.0.2 +PyYAML==6.0.1 pyyaml_env_tag==0.1 -regex==2024.11.6 -requests==2.32.3 +regex==2023.12.25 +requests==2.31.0 six==1.16.0 -urllib3==2.2.3 -watchdog==6.0.0 +tinycss2==1.4.0 +urllib3==2.1.0 +watchdog==4.0.0 +webencodings==0.5.1