Skip to content

Commit c113411

Browse files
committed
chore: update docs
1 parent 020dfda commit c113411

4 files changed

Lines changed: 17 additions & 39 deletions

File tree

docs/GOVERNANCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This package follows SemVer:
1212

1313
- Public package APIs and documented config keys are treated as compatibility surfaces.
1414
- New behavior defaults should remain backward-compatible in minor/patch releases.
15-
- Security hardening defaults that can change behavior should be called out in `docs/UPGRADE.md`.
15+
- Security hardening defaults that can change behavior should be called out in release notes.
1616

1717
## Deprecation policy
1818

@@ -26,5 +26,5 @@ When a key or behavior is superseded:
2626
## Release controls
2727

2828
- Run `composer pint -- --test`, `composer analyse`, and `composer test` before release.
29-
- Update `docs/UPGRADE.md` for behavior/config changes.
29+
- Update release notes for behavior/config changes.
3030
- Tag releases with semantic versions.

docs/UPGRADE.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ A flexible Attribute-Based Access Control (ABAC) implementation for Laravel 12+.
1111
- [Operations Guide](OPERATIONS.md)
1212
- [Benchmarking](BENCHMARKING.md)
1313
- [Security Model](SECURITY_MODEL.md)
14-
- [Upgrade Guide](UPGRADE.md)
1514

1615
## Key Features
1716

mkdocs.yml

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,32 @@ theme:
1414
scheme: default
1515
primary: blue
1616
accent: blue
17+
toggle:
18+
icon: material/weather-night
19+
name: Switch to dark mode
1720
- media: "(prefers-color-scheme: dark)"
1821
scheme: slate
1922
primary: blue
2023
accent: blue
24+
toggle:
25+
icon: material/weather-sunny
26+
name: Switch to light mode
2127

2228
markdown_extensions:
2329
- attr_list
2430
- md_in_html
2531
- tables
2632
- admonition
2733
- pymdownx.details
28-
- pymdownx.superfences
34+
- pymdownx.superfences:
35+
custom_fences:
36+
- name: mermaid
37+
class: mermaid
38+
format: !!python/name:pymdownx.superfences.fence_code_format
39+
40+
extra_javascript:
41+
- https://unpkg.com/mermaid@10/dist/mermaid.min.js
42+
- javascripts/mermaid.js
2943

3044
nav:
3145
- Home: index.md
@@ -36,5 +50,4 @@ nav:
3650
- Operations: OPERATIONS.md
3751
- Benchmarking: BENCHMARKING.md
3852
- Security Model: SECURITY_MODEL.md
39-
- Upgrade Guide: UPGRADE.md
4053
- Governance: GOVERNANCE.md

0 commit comments

Comments
 (0)