Skip to content

README.md

Latest commit

 

History

History
25 lines (19 loc) · 1.29 KB

README.md

File metadata and controls

25 lines (19 loc) · 1.29 KB
Raw

VelaShell Documentation (English)

中文:../zh/

Area Contents
host/ Host (main app) architecture, design specs, performance logs and feasibility research
plugins/ Plugin system design blueprint 01–15 and the status overview
sdk/ Plugin contract SDK reference
cli/ vela-plugin command-line manual
templates/ Plugin dev guide, packaging and publishing

Read in this order to write a plugin

  1. Dev guide — getting started, manifest, lifecycle, capability APIs, testing
  2. CLI manual — every vela-plugin command
  3. Publishing — .vpx, signing, shipping to the marketplace
  4. SDK reference — contract surface and capability domains (look things up here)

The plugin blueprint describes the host-side design and implementation. Read it to understand why plugins look the way they do; you do not need it to write one.

Release-process documents (release-process.md) exist in Chinese only, under ../zh/sdk/, ../zh/cli/ and ../zh/templates/.