/ mkdocs.yml
mkdocs.yml
1 site_name: Auths 2 site_description: Decentralized identity for developers. One identity, multiple devices, Git-native storage. 3 site_url: https://docs.auths.dev 4 repo_url: https://github.com/auths-dev/auths 5 repo_name: auths-dev/auths 6 7 theme: 8 name: material 9 custom_dir: overrides 10 logo: images/logo.png 11 # favicon: assets/favicon.ico # TODO: Add favicon 12 palette: 13 # Dark Mode (default) 14 - scheme: slate 15 primary: custom 16 accent: custom 17 toggle: 18 icon: material/weather-night 19 name: Switch to light mode 20 # Light Mode 21 - scheme: default 22 primary: white 23 accent: indigo 24 toggle: 25 icon: material/weather-sunny 26 name: Switch to dark mode 27 font: 28 text: Inter 29 code: JetBrains Mono 30 icon: 31 repo: fontawesome/brands/github 32 features: 33 - navigation.instant 34 - navigation.tracking 35 - navigation.tabs 36 - navigation.tabs.sticky 37 - navigation.sections 38 - navigation.prune 39 - navigation.path 40 - navigation.indexes 41 - toc.follow 42 - search.suggest 43 - search.highlight 44 - content.code.copy 45 - content.code.annotate 46 - content.tabs.link 47 - announce.dismiss 48 49 plugins: 50 - search 51 52 markdown_extensions: 53 - admonition 54 - pymdownx.details 55 - pymdownx.superfences: 56 custom_fences: 57 - name: mermaid 58 class: mermaid 59 format: !!python/name:pymdownx.superfences.fence_code_format 60 - pymdownx.tabbed: 61 alternate_style: true 62 - attr_list 63 - md_in_html 64 - pymdownx.emoji: 65 emoji_index: !!python/name:material.extensions.emoji.twemoji 66 emoji_generator: !!python/name:material.extensions.emoji.to_svg 67 - pymdownx.highlight: 68 anchor_linenums: true 69 line_spans: __span 70 pygments_lang_class: true 71 - pymdownx.inlinehilite 72 - pymdownx.snippets 73 - pymdownx.tasklist: 74 custom_checkbox: true 75 - def_list 76 - footnotes 77 - abbr 78 - tables 79 - toc: 80 permalink: true 81 toc_depth: 3 82 83 extra_css: 84 - stylesheets/extra.css 85 86 extra: 87 social: 88 - icon: fontawesome/brands/github 89 link: https://github.com/auths-dev/auths 90 91 nav: 92 - Home: index.md 93 94 - Getting Started: 95 - Installation: getting-started/install.md 96 - Your First Identity: getting-started/your-first-identity.md 97 - Signing Commits: getting-started/signing-commits.md 98 - Sharing Your Identity: getting-started/sharing-your-identity.md 99 - How It Works: getting-started/how-it-works.md 100 - Identity Lifecycle: getting-started/identity-lifecycle.md 101 - Delegation: getting-started/delegation.md 102 - Trust Model: getting-started/trust-model.md 103 104 - Guides: 105 - Identity Management: 106 - Multi-Device: guides/identity/multi-device.md 107 - Key Rotation: guides/identity/key-rotation.md 108 - Backup & Recovery: guides/identity/backup-and-recovery.md 109 - Profiles: guides/identity/profiles.md 110 - Git Integration: 111 - Signing Configuration: guides/git/signing-configuration.md 112 - Verifying Commits: guides/git/verifying-commits.md 113 - Team Workflows: guides/git/team-workflows.md 114 - Platform Integrations: 115 - GitHub Claims: guides/platforms/github-claims.md 116 - Radicle: guides/platforms/radicle.md 117 - CI/CD: guides/platforms/ci-cd.md 118 - Advanced: 119 - Custom Policies: guides/advanced/custom-policies.md 120 - WASM Verification: guides/advanced/wasm-verification.md 121 122 - CLI: 123 - Primary Commands: cli/commands/primary.md 124 - Advanced Commands: cli/commands/advanced.md 125 126 - SDK & Libraries: 127 - Rust SDK: 128 - Overview: sdk/rust/overview.md 129 - Quickstart: sdk/rust/quickstart.md 130 - Identity Operations: sdk/rust/identity-operations.md 131 - Signing & Verification: sdk/rust/signing-and-verification.md 132 - Error Handling: sdk/rust/error-handling.md 133 - Storage Backends: sdk/rust/storage-backends.md 134 - Verifier Embedding: 135 - FFI (C/C++): sdk/verifier/ffi.md 136 - WASM: sdk/verifier/wasm.md 137 - Python: sdk/verifier/python.md 138 - API Reference: sdk/crate-index.md 139 140 - Architecture: 141 - Design: 142 - Overview: architecture/overview.md 143 - Identity Model: architecture/identity-model.md 144 - Git as Storage: architecture/git-as-storage.md 145 - Attestation Format: architecture/attestation-format.md 146 - OIDC Bridge: architecture/oidc-bridge.md 147 - Cryptography: architecture/cryptography.md 148 - Crate Deep Dives: 149 - auths-core: architecture/crates/auths-core.md 150 - auths-id: architecture/crates/auths-id.md 151 - auths-verifier: architecture/crates/auths-verifier.md 152 - auths-sdk: architecture/crates/auths-sdk.md 153 154 - Contributing: 155 - Getting Started: 156 - Development Setup: contributing/development-setup.md 157 - Project Structure: contributing/project-structure.md 158 - Coding Standards: contributing/coding-standards.md 159 - Workflow: 160 - Testing Guide: contributing/testing-guide.md 161 - Pull Request Process: contributing/pull-request-process.md 162 - Release Process: contributing/release-process.md 163 - Reference: 164 - Architecture Decisions: contributing/architecture-decisions.md 165 - Glossary: contributing/glossary.md