pyvider-rpcplugin/mkdocs.yml at main · provide-io/pyvider-rpcplugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# Inherit shared configuration from provide-foundry
INHERIT: .provide/foundry/base-mkdocs.yml

# Project-Specific Configuration
site_name: pyvider-rpcplugin
site_description: High-performance, type-safe RPC plugin framework for Python with built-in security, async support, and production-ready patterns
site_author: provide.io
site_url: https://rpcplugin.provide.io
repo_url: https://github.com/provide-io/pyvider-rpcplugin
repo_name: provide-io/pyvider-rpcplugin
edit_uri: edit/main/docs/
copyright: ©2024-2025 provide.io llc<br/>🛠️ with 💚 and 🦝 on 🌎

# Development server configuration
dev_addr: 127.0.0.1:11007

# Project-specific theme overrides
theme:
  font:
    text: Inter
    code: Fira Code
  palette:
    # Light mode - custom colors for pyvider-rpcplugin
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode - custom colors for pyvider-rpcplugin
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.prune  # Additional feature specific to this project

# Project-specific plugins (in addition to base plugins)
plugins:
  - gen-files:
      scripts:
        - .provide/foundry/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md

# Project-specific extra configuration
extra:
  version:
    provider: mike
    default: latest

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/provide-io/pyvider-rpcplugin
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyvider-rpcplugin/
    - icon: fontawesome/solid/globe
      link: https://provide.io

  analytics:
    provider: google
    property: G-XXXXXXXXXX

  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

# Watch configuration
watch:
  - src/pyvider
  - docs
  - mkdocs.yml

nav:
  - Home: index.md

  - Introduction:
    - introduction/index.md
    - Foundation Integration: introduction/foundation.md

  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Your First Plugin: getting-started/first-plugin.md
    - Examples Overview: getting-started/examples.md

  - User Guide:
    - guide/index.md
    - Core Concepts:
      - guide/concepts/index.md
      - RPC Architecture & Handshake: guide/concepts/architecture-and-handshake.md
      - Transports: guide/concepts/transports.md
      - Protocols: guide/concepts/protocols.md
      - Security Model: guide/concepts/security.md

    - Server Development:
      - guide/server/index.md
      - Basic Server Setup: guide/server/basic-setup.md
      - Service Implementation: guide/server/services.md
      - Transport Configuration: guide/server/transports.md
      - Async Patterns: guide/server/async-patterns.md
      - Health Checks: guide/server/health-checks.md

    - Client Development:
      - guide/client/index.md
      - Client Development Guide: guide/client/client-guide.md
      - Connection Resilience: guide/client/resilience.md
      - Direct Connections: guide/client/direct-connections.md

    - Security:
      - guide/security/index.md
      - mTLS Configuration: guide/security/mtls.md
      - Certificate Management: guide/security/certificates.md
      - Certificate API Reference: guide/security/certificate-reference.md
      - Magic Cookies: guide/security/magic-cookies.md
      - Process Isolation: guide/security/process-isolation.md

    - Configuration:
      - guide/config/index.md
      - Configuration Reference: guide/config/configuration-reference.md
      - Config vs Factory Parameters: guide/config/configuration-vs-factory-parameters.md
      - Configuration Guide: guide/config/configuration-guide.md
      - Advanced Configuration: guide/config/advanced.md
      - Environment Variables: guide/config/environment.md
      - Logging Configuration: guide/config/logging.md

    - Advanced Topics:
      - Observability & Performance: guide/advanced/observability.md
      - Type System & Custom Protocols: guide/advanced/customization.md
      - Plugin Lifecycle: guide/advanced/lifecycle.md
      - Middleware: guide/advanced/middleware.md
      - Foundation Integration: guide/advanced/foundation-integration.md

    - Best Practices: guide/best-practices.md

  - API Reference:
    - reference/index.md
    - Glossary: reference/glossary.md

  - Examples:
    - examples/index.md
    - Quick Start: examples/quick-start.md
    - Echo Service: examples/echo-example.md

  - Development:
    - development/index.md
    - Contributing Guide: development/contributing-guide.md
    - Architecture: development/architecture.md
    - Testing: development/testing.md
    - Troubleshooting: development/troubleshooting.md

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

watch:
  - src/pyvider
  - docs
  - mkdocs.yml