Skip to content

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

FluentCommunity Developer Docs

Developer documentation for FluentCommunity — the WordPress community plugin by WPManageNinja.

Live site: dev.fluentcommunity.co

What's inside

  • Database — Schema overview, Eloquent-style models, relationships, and query builder usage
  • Hooks — Every action and filter in core and Pro (466 hooks across 616 call sites) with parameters, call sites and examples
  • REST API — All 248 endpoints with an interactive playground, real recorded request/response samples, and the permissions each one needs
  • Helpers — Utility classes and commonly used helper methods
  • Guides — Code snippets, menu customization, theme compatibility, webhooks, cloud storage
  • Deployment — Server requirements, performance optimization, and benchmarks

Local development

yarn install
yarn docs:dev      # Start dev server with hot reload
yarn docs:build    # Production build
yarn docs:preview  # Preview production build locally

docs:dev and docs:build auto-generate the database, hook and REST API references from the FluentCommunity plugin source before starting VitePress. Anything under docs/database/, docs/hooks/, docs/restapi/, docs/modules/ and public/openapi/ is deleted and rewritten on every run — edit scripts/generate-docs.mjs or the prose files in data/, never those pages.

REST samples are recorded from a live install rather than synthesised; see scripts/capture/README.md.

Tech stack

Contributing

Found an issue or want to improve the docs? PRs are welcome. Each page has an "Edit this page" link that takes you directly to the source file.

License

Copyright © 2026 WPManageNinja

Featured (social-share) images

Every page has its own link-preview card — the image Slack, X, LinkedIn and Facebook show when a docs URL is shared. Cards are generated, not designed by hand: scripts/generate-featured-images.mjs renders a branded 1200×630 PNG carrying the page's title and section into public/images/featured/, and the VitePress config (featuredImageFor()) points each page's og:image / twitter:image at it. A page with no card falls back to default.png.

npm run featured:generate     # render cards for pages that don't have one yet (idempotent)
npm run featured:regenerate   # re-render every card (after changing the generator's design)
  • Run npm run featured:generate after adding a page and commit the PNG alongside it.
  • If you rename or retitle a page, delete its old card first and run the generator again — it skips existing files and only reports orphans, it never deletes them.
  • Card naming rule: the page's served path (after rewrites) minus .md, with / replaced by --, plus .png. It lives in both the script (cardNameFor()) and the config (featuredImageFor()) — change one, change the other.

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages