Skip to content
/ docs Public

Comprehensive documentation for the CitOmni Framework - a high-performance, low-overhead PHP 8.2+ framework. Includes architecture guides, configuration reference, runtime concepts, provider development, CLI and HTTP usage, deployment tips, performance tuning, and contribution standards.

License

Notifications You must be signed in to change notification settings

citomni/docs

CitOmni Documentation (Work in Progress)

This repository hosts the public documentation for the CitOmni Framework.

Heads up: The documentation is a work in progress. If you're missing anything specific, please reach out at support@citomni.com.

Available docs (auto-generated)

concepts

contribute

cookbook

get-started

how-to

legal

packages

policies

programs

reference

release-notes

reports

troubleshooting

Expected structure (reference)

Below is the planned layout. Some sections may be empty while we migrate content.

/README.md
/get-started/
  quickstart-http.md
  quickstart-cli.md
  skeletons.md
/concepts/
  runtime-modes.md
  config-merge.md          # deterministic "last-wins"
  services-and-providers.md
  caching-and-warmup.md
  error-handling.md
/how-to/
  build-a-provider.md
  routes-and-controllers.md
  csrf-cookies-sessions.md
  perf-budgets-and-metrics.md  # p95 TTFB, RSS, req/watt-notes
  deployment-one.com.md
/troubleshooting/
  providers-autoload.md
  routes-404.md
  csrf-token-mismatch.md
  caching-warmup.md
  composer-autoload.md
  http-500-during-boot.md
/policies/
  security.md
  public-uploads.md
  cache-and-retention.md
  backups.md
  data-protection.md
  error-pages.md
  maintenance.md
/reference/
  config-keys.md           # complete key list with examples
  cli-commands.md
  http-objects.md          # Request/Response/Cookie
  router-reference.md
/packages/
  kernel.md
  http.md
  cli.md
  auth.md
  testing.md
/cookbook/
  cms-starter.md
  commerce-notes.md
  admin-starter.md
/contribute/
  conventions.md           # coding/documentation conventions
  docs-style-guide.md      # tone, examples, code blocks
  issue-templates.md
/legal/
  licenses.md              # MIT/GPL explanations, SPDX
  trademark.md             # TM usage, "official", "certified"
  notice-template.md
/programs/
  certification.md         # criteria, green KPIs
  partners.md              # partner program guidelines
/release-notes/
  index.md                 # links to package CHANGELOGs
/assets/
  img/ css/ js/

This README was generated automatically.
Last updated: 2026-01-23 01:10:20

About

Comprehensive documentation for the CitOmni Framework - a high-performance, low-overhead PHP 8.2+ framework. Includes architecture guides, configuration reference, runtime concepts, provider development, CLI and HTTP usage, deployment tips, performance tuning, and contribution standards.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages