PHPackages                             phalcana/userguide - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. phalcana/userguide

ActivePhalcana-module[Utility & Helpers](/categories/utility)

phalcana/userguide
==================

Userguide module for Phalcana project based of the module for Kohana of the same name

v0.8.1(10y ago)0281BSD-3-ClauseCSS

Since Sep 11Pushed 10y ago1 watchersCompare

[ Source](https://github.com/braf/phalcana-userguide)[ Packagist](https://packagist.org/packages/phalcana/userguide)[ Docs](http://phalcana.com)[ RSS](/packages/phalcana-userguide/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (3)Versions (3)Used By (1)

[![Latest Stable Version](https://camo.githubusercontent.com/11e6869c5d080208e33cc9c9dcf39a714e30f22cb5a605c0b14073fedc151988/68747470733a2f2f706f7365722e707567782e6f72672f7068616c63616e612f7573657267756964652f762f737461626c65)](https://packagist.org/packages/phalcana/userguide)[![Build Status](https://camo.githubusercontent.com/4d6551c8d03867b0ec24ad1d75f92e51892463ab6d5886f56cb83121849eac78/68747470733a2f2f7472617669732d63692e6f72672f627261662f7068616c63616e612d7573657267756964652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/braf/phalcana-userguide)[![Total Downloads](https://camo.githubusercontent.com/cab265752706bca1b90b852393c6ec1a8bef31e893caa84cb5c53a295269f544/68747470733a2f2f706f7365722e707567782e6f72672f7068616c63616e612f7573657267756964652f646f776e6c6f616473)](https://packagist.org/packages/phalcana/userguide)[![License](https://camo.githubusercontent.com/43588949b2e970d07f3826a8155e51a880aad9304a35b69b2e2ddcc598cedebc/68747470733a2f2f706f7365722e707567782e6f72672f7068616c63616e612f7573657267756964652f6c6963656e7365)](https://packagist.org/packages/phalcana/userguide)

Phalcon Userguide Module
========================

[](#phalcon-userguide-module)

Userguide module for the [Phalcana project](http://github.com/braf/phalcana-project) based on the one for Kohana.

Installation
------------

[](#installation)

This module is installed by default with the Phalcana project by composer when dev modules are included for more information see the [Phalcana Project](http://github.com/braf/phalcana-project).

In order for the module to be loaded into Phalcana the module needs to be added into the modules config. This can be found in the `app/config/static.php` or in the local version `app/config/setup.php`. For example.

```
'modules' => array(
  'email' => MODPATH.'email/',
  'userguide' => MODPATH.'userguide/',
),
```

Basic Usage
-----------

[](#basic-usage)

Once the module is sucessfully installed you can access it in your project by accessing the URL at `/guide`.

Adding To The Guide
-------------------

[](#adding-to-the-guide)

Files for the guide are added inside each module and the system folder in `guide/module-name`. Files added are added in the Markdown syntax. See below about Markdown for more info.

The homepage for each module should be name `index.md` and the menu structure to connect the files together should be added in a `menu.md` file.

API Browser
-----------

[](#api-browser)

The user guide also contains an API browser assembled from DOC blocks within the code. This works much the same as PHPDocumentor and is organised by using the main class DOC blocks sorting first by `@package` then by `@category`. Code blocks use Markdown to format documentation for the class and each individual function. For more details on the Markdown syntax please see below.

Markdown
--------

[](#markdown)

Most of the markdown parsing is handled by [PHP Markdown](https://michelf.ca/projects/php-markdown/). For detailed information please visit the documentation. There are modifications that allow rewriting of local links

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~5 days

Total

2

Last Release

3898d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6f992e95d609f021f0d17592b9731e4e2e494e54d16a3170c87911274e6268f9?d=identicon)[braf](/maintainers/braf)

---

Top Contributors

[![braf](https://avatars.githubusercontent.com/u/2203426?v=4)](https://github.com/braf "braf (15 commits)")

---

Tags

kohanaphalconPhalcana

### Embed Badge

![Health badge](/badges/phalcana-userguide/health.svg)

```
[![Health](https://phpackages.com/badges/phalcana-userguide/health.svg)](https://phpackages.com/packages/phalcana-userguide)
```

###  Alternatives

[phalcon/zephir

Zephir is a compiled high level language aimed to the creation of C-extensions for PHP

3.4k414.1k18](/packages/phalcon-zephir)[phalcon/ide-stubs

The most complete Phalcon Framework IDE stubs library which enables autocompletion in modern IDEs.

1623.1M121](/packages/phalcon-ide-stubs)[bmidget/kohana-formo

Formo is a form module for Kohana 3 that lets you work with forms as objects

1328.4k](/packages/bmidget-kohana-formo)[phalcongelist/php-diff

A comprehensive library for generating differences between two hashable objects (strings or arrays).

12435.5k2](/packages/phalcongelist-php-diff)[izica/phalcon-meta-tags

Phalcon PHP Meta tags service

1215.9k](/packages/izica-phalcon-meta-tags)[stanislav-web/phalcon-sms-factory

Multiple gateway SMS Sender factory. Provide any SMS services inside your Phalcon's projects

321.6k](/packages/stanislav-web-phalcon-sms-factory)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)