Skip to content
Omnisense
Star0 FR

241 manuals · 29 families and groups

Documentation

The guides first; then 241 manuals, one per package, each read from its repository's docs/ folder at the commit the site pins - a pencil on every page to propose a change.

1 — Where to start

Getting started

The pages that hold for every package: what they are, where they run, what they share, how to correct them.

  1. 01Getting startedThe foundation and the optional prepared structures; installing a family or the core in a few lines.
  2. 02ArchitectureThe core and the application, the families and their providers, the bridges, and how this website itself is built.
  3. 03CompatibilityWhat runs in plain PHP, what runs under Symfony and Laravel, what the bridges cover.
  4. 04ConventionsNames, versions and Composer constraints, the MIT licence, "verified for real".
  5. 05ContributingThe pencil, the fork, the pull request; writing a page, a piece of news, a catalogue entry.
  6. 06Writing a providerFrom the template to a release - implement a family's contract, run its conformance suite, document what was verified, publish a version.

2 — Reference

One manual per package

Each package's docs/ folder, read at an immutable commit; each package has its own version series. Where each package stands is read in the package search.

JavaScript libraries

Omniauth

Sign people in, by whichever factors.

Omnibank

Read a bank account.

Omnibase

The core of the sites, and optional ready-made structures.

Omnibill

Send and receive an electronic invoice.

Bridges

Omnibus

Ship a parcel, whatever the carrier.

Omnidns

Manage a domain name where it is registered.

Omnidocs

Omnidrive

Read and write files, wherever they are kept.

Omnifood

Receive a restaurant's orders and reservations.

Omnifund

Read who funds a project.

Omnilab

Read what science knows of a thing, or measures at a place.

Omnilex

Read the sources of law.

Omnimap

Draw a map, whoever provides it.

Omnimeet

Open a video room and let someone in.

Omniplay

Put a game on the stores, and play it online.

Omnipost

Publish on the social networks, and share a page to them without their scripts.

Omnireach

Read what outside tools know of a site's audience.

Omnireview

Read what customers say elsewhere.

Omnischolar

Gather a researcher's publications.

Omnisearch

Search, whatever the engine.

Omnishield

Guard a form: captcha, spam, addresses known for abuse.

Omnishow

Omnisign

Have a document signed.

Omnisong

Let a musician's catalogue be heard.

Omnistate

Ask the public registers what they know.

Omniticket

Read the tickets sold elsewhere.

Omnitrade

Take payments and sell, whatever the provider.

3 — Contribute

Correct a page

On every page, the pencil "Propose a change" opens GitHub's editor on the Markdown file, at the branch the series follows. Without write access, GitHub offers the fork and the pull request; the page changes here once its commit is pinned again.

The path in detail GitHub · glitchr-omnisense