Internal Documentation¶

This section is for WB-specific standards, conventions, and "how we do things" documentation. Content here supplements the P21 platform reference with our own decisions and patterns.

Suggested Sections to Add¶

Our P21 Environment¶

• Server URLs (dev, test, prod)
• Credential management and rotation procedures
• VPN/network access requirements
• Who to contact for API access

Our Development Standards¶

• Naming conventions for business rules (e.g., WB.P21.Rules.{Module})
• Git workflow for rules and integrations
• Testing procedures before deploying rules to production
• Code review requirements

Our Business Rules Library¶

• Index of all currently deployed business rules
• Which rules are on which windows/fields/events
• Known issues or quirks
• Deprecation log for retired rules

Our Integrations¶

• Map of all external systems connected to P21
• Data flow diagrams
• Error handling and alerting setup
• Integration runbooks for common failures

Our Custom Fields (UDFs)¶

• Master list of all user-defined fields by entity
• Purpose and usage notes for each UDF
• Who requested each field and why

Release Management¶

• Our process for applying P21 updates
• Testing checklist before upgrade
• Post-upgrade validation procedures
• SDK version upgrade history

How to Add to This Section¶

1. Create a new .md file in the docs/internal/ folder
2. Add it to the nav section in mkdocs.yml
3. Commit and push — the site rebuilds automatically via GitHub Actions

Example:

docs/
  internal/
    index.md          ← this file
    environments.md   ← dev/test/prod server details
    our-rules.md      ← our deployed business rules
    integrations.md   ← our external integrations
    udfs.md           ← our custom fields

Then in mkdocs.yml:

  - Internal:
    - Overview: internal/index.md
    - Environments: internal/environments.md
    - Our Rules: internal/our-rules.md
    - Integrations: internal/integrations.md
    - Custom Fields: internal/udfs.md