docs: initial documentation

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

README.md

@@ -32,7 +32,7 @@ natrix
 natrix --help                         # Show help message
 natrix --version                      # Show version information
 natrix --list-rules                   # List all available rules
-natrix --disable NTX001 NTX002        # Disable specific rules
+natrix --disable NTX1 NTX2        # Disable specific rules
 natrix --rule-config RuleName.param=value  # Configure rule parameters
 ```
 
@@ -46,7 +46,7 @@ You can configure Natrix using a `pyproject.toml` file in your project root:
 files = ["contracts/", "tests/contracts/"]
 
 # Rules to disable
-disabled_rules = ["NTX001", "NTX002"]
+disabled_rules = ["NTX1", "NTX2"]
 
 # Rule-specific configurations
 [tool.natrix.rule_configs.RuleName]