Skip to content

Document 10+ undocumented module types in DOCUMENTATION.md #66

Description

@intel352

Problem

The following features exist in code but are entirely absent from DOCUMENTATION.md and README.md:

  • audit/ — audit logging system
  • plugins/license/ — license.validator module
  • platform.provider, platform.resource, platform.context modules
  • step.ai_complete, step.ai_classify, step.ai_extract pipeline steps
  • CI/CD steps: step.docker_build, step.docker_push, step.docker_run, step.scan_sast, step.scan_container, step.scan_deps, step.artifact_push, step.artifact_pull
  • step.jq — JSON query transformations
  • plugin/admincore/ — admin platform plugin
  • observability.otel — no example YAML or configuration guide

Fix Direction

For each module type, add a section to DOCUMENTATION.md with: description, configuration keys (with types and defaults), and a minimal YAML example. Follow the existing pattern for documented modules.

Context

See docs/DEFERRED_ISSUES.md — Code Smells / Minor section.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions