Skip to content

Repository files navigation

RepoDocs Intelligence

RepoDocs Intelligence is a WordPress plugin for turning Git repositories into living, evidence-backed technical documentation.

Architecture

The plugin separates WordPress integration, Git providers, analysis, persistence, background jobs, security, AI and frontend concerns. Repository source is treated as untrusted data and is statically inspected rather than executed.

Git Provider -> Queue -> Repository Analyzer -> Intelligence Data -> Documentation -> Search/UI
                                      \-> optional grounded AI Q&A

Key design principles

  • Deterministic truth first: symbols, files, dependencies, APIs and schemas come from source analysis; AI is optional and explanatory.
  • Incremental synchronization: unchanged files reuse prior analysis by source SHA; affected data is rebuilt when content changes.
  • Safe by default: no repository scripts/builds are executed; credentials are encrypted; external base URLs are validated; access and REST routes are capability/visibility gated.
  • WordPress-native publishing: WordPress owns project access, administration, URLs and presentation while high-volume intelligence data lives in dedicated tables.
  • Replaceable integrations: Git and AI features are behind interfaces/factories so additional providers can be added without coupling them to UI code.

Implemented capabilities

  • GitHub, GitLab and Gitea/Forgejo-compatible connections.
  • Repository discovery, project creation, branch selection and queued sync.
  • File tree, language detection, binary/path filtering and source browser.
  • PHP token-based symbol extraction plus heuristic multi-language symbol extraction.
  • Dependency, framework, route/API and database-table detection.
  • Deterministic Overview, Getting Started, Architecture, Dependencies, API and Database documentation.
  • Documentation health score and repository revision snapshots.
  • PHP inheritance/interface extraction and deterministic relationship edges.
  • WP-CLI commands for queued sync, worker execution and job status.
  • Project search and optional evidence-grounded OpenAI-compatible Q&A.
  • Public/private project access policy and documentation feedback.
  • GitHub/GitLab webhook verification and sync queuing.
  • llms.txt endpoint for published project knowledge.
  • Responsive documentation portal, dark mode, keyboard search, deep-linked source lines and basic dependency visualization.
  • REST API for project/tree/symbol/search/Q&A/feedback operations.

Explicit scope boundaries in 0.2.0

The architecture is prepared for broader product capabilities, but this release does not claim complete implementations of Bitbucket/Azure DevOps adapters, multi-repository workspaces, full AST coverage for every language, a sandboxed dynamic analyzer, advanced UML/C4 rendering, PR/MR status checks, MCP server, SAML/SCIM, or enterprise worker clusters. Those require additional provider-specific and integration-specific validation.

Requirements

  • WordPress 6.7+
  • PHP 8.1+
  • HTTPS recommended for provider integrations
  • PHP Sodium or OpenSSL strongly recommended for encrypted credentials

Development checks

composer install
composer lint
composer test
composer phpcs
node --check assets/js/admin.js
node --check assets/js/public.js

The package includes phpcs.xml.dist with WordPress Coding Standards and PHPCompatibilityWP rules.

Security model

  1. Imported repositories are untrusted input.
  2. Standard analysis never invokes exec, shell_exec, system, proc_open, package managers, builds or repository binaries.
  3. External provider URLs are HTTPS-only and must resolve to public IP space unless explicitly allowed by a filter.
  4. Credentials are encrypted before database storage.
  5. Administrative mutations use capability checks and WordPress nonces.
  6. Public REST operations enforce project visibility and rate limiting where appropriate.
  7. Webhook handlers verify provider signatures/tokens and deduplicate deliveries.
  8. AI context is limited to selected evidence and redacted for common credential patterns before transmission.

Extending Git providers

Implement RepoDocs\Git\GitProviderInterface, then register/instantiate the adapter through ProviderFactory.

Extending parsers

Implement RepoDocs\Analysis\SymbolParserInterface or add a framework-specific analyzer. The analyzer layer is deliberately separate from publishing so deterministic analysis can evolve without changing the documentation UI.

License

GPL-2.0-or-later.

About

RepoDocs Intelligence is a WordPress plugin that transforms GitHub, GitLab, Gitea and Forgejo repositories into living technical documentation with code intelligence, source browsing, API and dependency analysis, documentation health, secure webhooks, search, AI-assisted Q&A, and responsive developer docs.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages