kontent-ai/delivery-sdk-php

Generate API reference using phpDocumentor

Open

#64 opened on Aug 20, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)PHP (13 forks)auto 404
cienhancementgroomedhacktoberfesthelp wanted

Repository metrics

Stars
 (46 stars)
PR merge metrics
 (PR metrics pending)

Description

Use phpDocumentor to generate HTML API reference from php-style comments.

Resources:

Contributor guide

Research direction
Set up phpDocumentor to generate HTML documentation from PHP docblocks. Create a CI script to run phpDocumentor and deploy the output to the gh pages branch or to the kentico.github.io repository. Follow the manual generation process described in the wiki, then automate it with a CI workflow (e.g., GitHub Actions).
Tech stack
php
Domain
documentationdevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHPGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70