PHPackages                             iquesters/help-support - 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. iquesters/help-support

ActiveLibrary

iquesters/help-support
======================

Help support package

v1.0.2(1mo ago)05↓100%3[2 issues](https://github.com/iquesters/help-support/issues)MITPHPCI passing

Since Mar 24Pushed 1mo agoCompare

[ Source](https://github.com/iquesters/help-support)[ Packagist](https://packagist.org/packages/iquesters/help-support)[ RSS](/packages/iquesters-help-support/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

Help Support
============

[](#help-support)

The `help-support` package provides an in-app documentation browser for installed Iquesters modules.

Package Wiring
--------------

[](#package-wiring)

- Service provider: `Iquesters\HelpSupport\HelpSupportServiceProvider`
- view namespace: `help-support::`
- Blade pages use `@extends(app('app.layout'))`
- package configuration is managed through `HelpSupportConf`

Routes
------

[](#routes)

- `GET /help-support/{viewName}`
- `GET /help-support/docs/files/{module}`
- `GET /help-support/docs/file?url=...`

These routes are handled by `Iquesters\HelpSupport\Http\Controllers\UiController`.

What It Does
------------

[](#what-it-does)

- shows the current user only the modules they can access
- loads documentation file lists from GitHub repositories
- supports nested markdown files under the configured docs root
- enforces role-based documentation visibility
- caches both docs file lists and raw markdown content

Current Views
-------------

[](#current-views)

- `help-support::helps.index`
- `help-support::helps.module`
- `help-support::helps.docs`

Documentation Source
--------------------

[](#documentation-source)

By default, docs are read from:

- repository owner: `iquesters`
- docs root path: `docs/`
- default branch fallback: `main`

These values are configurable in `HelpSupportConf`.

Visibility Rules
----------------

[](#visibility-rules)

- full-access roles are configured through `HelpSupportConf::docs_full_access_roles`
- default visible docs paths are configured through `HelpSupportConf::docs_default_visible_paths`

Typical default behavior:

- `super-admin` and `iq-developer` can view all docs under `docs/**`
- other users can view only `docs/users/**`

Recommended Docs Folder Structure
---------------------------------

[](#recommended-docs-folder-structure)

Inside each module repository, organize documentation by audience first:

```
docs/
  users/
    getting-started.md
    faq.md
    profile/
      account-settings.md

  admin/
    dashboard/
      overview.md
    module-management.md
    role-assignment.md

  developer/
    architecture.md
    api/
      authentication.md
      webhooks.md
    deployment/
      environment.md

  shared/
    glossary.md
    release-notes.md

```

Recommended usage:

- keep end-user documentation inside `docs/users/`
- keep privileged operational docs inside `docs/admin/`
- keep technical implementation and integration docs inside `docs/developer/`
- keep cross-audience references, release notes, and shared terminology inside `docs/shared/`

This structure works well when a module has multiple documentation types, because users can immediately understand where to add new files:

- user-facing guides: `docs/users/`
- admin and support procedures: `docs/admin/`
- developer and API references: `docs/developer/`
- common references: `docs/shared/`

Notes
-----

[](#notes)

- nested markdown files are supported
- raw GitHub file access is revalidated in the controller before content is returned
- see `docs/docs-access-flow.md` for the full request and caching flow

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance90

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~0 days

Total

3

Last Release

46d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f4dcd42249f784c4fa056815878ce2ea00bd0deb31b0d1858a73e02a82831156?d=identicon)[pritam](/maintainers/pritam)

---

Top Contributors

[![glitched-matrix44](https://avatars.githubusercontent.com/u/255717373?v=4)](https://github.com/glitched-matrix44 "glitched-matrix44 (10 commits)")[![PritamBag](https://avatars.githubusercontent.com/u/130136389?v=4)](https://github.com/PritamBag "PritamBag (9 commits)")[![adri-chak](https://avatars.githubusercontent.com/u/253419852?v=4)](https://github.com/adri-chak "adri-chak (5 commits)")

###  Code Quality

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/iquesters-help-support/health.svg)

```
[![Health](https://phpackages.com/badges/iquesters-help-support/health.svg)](https://phpackages.com/packages/iquesters-help-support)
```

###  Alternatives

[anourvalar/eloquent-serialize

Laravel Query Builder (Eloquent) serialization

11320.2M21](/packages/anourvalar-eloquent-serialize)[namu/wirechat

A Laravel Livewire messaging app for teams with private chats and group conversations.

54324.5k](/packages/namu-wirechat)[statamic-rad-pack/runway

Eloquently manage your database models in Statamic.

135192.6k5](/packages/statamic-rad-pack-runway)

PHPackages © 2026

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