Skip to content

ROADMAP.md

Latest commit

 

History

History
52 lines (41 loc) · 2.72 KB

ROADMAP.md

File metadata and controls

52 lines (41 loc) · 2.72 KB
Raw

OrbUX roadmap

OrbUX is preparing its first public release. This roadmap lists the work that matters to users and contributors. It is intentionally short; accepted work is tracked in issues and shipped work belongs in the changelog.

Before the repository becomes public

  • Scan the full Git history and CI logs for credentials and private data.
  • Enable GitHub Private Vulnerability Reporting and test the reporting flow.
  • Establish the confidential conduct-reporting address required by the Code of Conduct.
  • Run browser verification in CI (unit/catalog tests already run with build and lint).
  • Review loader names, visuals, source, and assets for licensing and trademark concerns.
  • Add repository rules for main after the visibility change.

First release

  • Keep publishing under @vikast908/core and @vikast908/loaders (Plan A; live on npm, product tags stay orbux-*).
  • Publish @vikast908/*@0.1.1 with a correct loaders → core dependency (not workspace:* / @orbux/core).
  • Add NPM_TOKEN (Automation token with 2FA bypass) so tagged releases publish via npm-publish.yml.
  • Deprecate broken @vikast908/loaders@0.1.0 so installs warn consumers toward 0.1.1+.
  • Smoke-test install of @vikast908/core@0.1.1 + @vikast908/loaders@0.1.1 in a clean app.
  • Publish the gallery at a verified domain and add it to the repository metadata.
  • Document the supported browser range and package release policy.

Component work

  • Add visual regression coverage for every state and rendering tier.
  • Expand browser tests for progress, pause, reconnect, resize, context restoration, and reduced motion.
  • Headless gallery UI audit (pnpm test:ui).
  • Review similar structural recipes and keep only combinations with a clear visual purpose (every motion now has a distinct per-layout rendering; no recipe duplicates another).
  • Add more handcrafted loaders where a new silhouette, material, or motion language is missing.
  • Keep Canvas and WebGL work within explicit frame-time and resource budgets.

Developer experience

  • Add focused examples for React, Vue, Svelte, and plain HTML.
  • Document server rendering and custom-element upgrade behavior.
  • Build a small CLI only after package installation and copy-paste workflows are stable.
  • Consider a Lottie tier only when an authored animation justifies the runtime cost.

Not planned

  • Variants counted as separate loaders when only color, size, speed, or state changes.
  • Runtime dependencies for effects that the platform can implement clearly.
  • Copied franchise symbols, character artwork, or trademark-dependent loader names.
  • A compatibility layer that hides or changes the standard Web Component API.