mainwp/mainwp.dev
1
0
Fork 0
mirror of https://gh.llkk.cc/https://github.com/mainwp/mainwp.dev.git synced 2025-10-04 15:43:04 +08:00
Code Issues Projects Packages Wiki Activity Actions
mainwp.dev/memory-bank/techContext.md
Dennis Dornon ca95f1d826 Initial run of PHPDocumentor
2025-03-17 13:49:10 -04:00

2.4 KiB
Raw Blame History

Tech Context

Technologies Used

  1. phpDocumentor 3.7.1: The primary documentation generation tool that parses PHP source code and generates structured documentation.

  2. GitHub Actions: CI/CD platform used to automate the documentation generation and deployment process.

  3. GitHub Pages: Hosting platform for the generated documentation.

  4. PHP: The primary programming language of the MainWP ecosystem being documented.

  5. HTML/CSS/JavaScript: Used for the custom home page and additional developer resources.

  6. Markdown: Used for supplementary documentation and README files.

  7. XML: Used for phpDocumentor configuration files.

  8. Git: Version control system for managing source code and documentation.

Development Setup

  1. Local Environment:

    • PHP 7.4+ installed locally for testing phpDocumentor
    • Git for version control
    • Text editor or IDE (e.g., VSCode, PHPStorm)

  2. GitHub Repository:

    • Repository for the MainWP.dev documentation project
    • Access to the two MainWP source repositories

  3. phpDocumentor Configuration:

    • Configuration files for each source repository
    • Custom templates if needed

  4. GitHub Actions Configuration:

    • Workflow files for automating documentation generation
    • Secrets and permissions configured for repository access

Technical Constraints

  1. phpDocumentor Limitations:

    • Requires properly documented code with PHPDoc comments
    • May have issues with certain PHP language features
    • Performance considerations for large codebases

  2. GitHub Pages Constraints:

    • Limited to static content
    • No server-side processing
    • Size limitations for repositories

  3. GitHub Actions Constraints:

    • Limited execution time for workflows
    • Limited storage for artifacts
    • Rate limiting for API calls

  4. Documentation Completeness:

    • Dependent on the quality of source code documentation
    • May require manual supplementation for poorly documented areas

Dependencies

  1. External Services:

    • GitHub (for repository hosting, GitHub Actions, and GitHub Pages)

  2. Software Dependencies:

    • phpDocumentor 3.7.1
    • PHP 7.4+ (for running phpDocumentor)
    • Git (for version control)

  3. Source Code Dependencies:

    • Access to the two MainWP source repositories
    • Properly documented source code with PHPDoc comments

  4. Workflow Dependencies:

    • GitHub Actions runners
    • Repository permissions and secrets