Working on Seed
This section holds the guides for people who change the Seed repository, and it covers setup and tests, editing these docs, local CI, releases, package publishing and the app environment.

This section is for people and coding agents who change the code of Seed. All the code is in one repository, github.com/seed-hypermedia/seed. The repository holds the daemon, the apps, the app environment, the vault, the deployment tools and the markdown for these docs (see Editing these docs).

Pick the section that fits what you want to do:

Start with Contributing. It gets the repository running on your machine and names the checks every change needs. Each of the other pages covers one job.

Setup and checks

    Contributing shows the layout of the repository, the setup, the development stack and the checks for each area. It also has the rules for storage migrations, protobuf and protocol changes.

    Local CI with agent-ci runs the GitHub Actions workflows on your own machine before you push. Read it when a check fails only in CI, or when you want a faster loop.

    Editing these docs explains the hypermedia/ folder, the checks it must pass, how to edit it locally, and when a change reaches the published site.

Shipping

    Releasing is the maintainer's list of steps for a production release: version, tag, build, release notes, auto-update.

    Package publishing explains how GitHub Actions publishes the four npm packages: the SDK, the CLI, the agents UI and the UI components.

    Sentry says which Sentry project each program reports errors to, where each setting is in the code, and how to find an error.

The app environment

    Development is the guide to changing the server that runs Seed Agents: commands, local URLs, conventions and step lists for the common changes.

    Code map says which file holds what in the app environment and its shared UI, and which test file covers it.

    Testing the app environment covers its test suites and gates.

See also

Pages in this section

Do you like what you are reading? Subscribe to receive updates.

Unsubscribe anytime

Connections0
Linked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentCode map ยท Child document ยท Outgoing linkCode mapContributing ยท Child document ยท Outgoing linkContributingDevelopment ยท Child document ยท Outgoing linkDevelopmentEditing these docs ยท Child document ยท Outgoing linkEditing these docsLocal CI with agent-ci ยท Child document ยท Outgoing linkLocal CI with agent-ciPackage publishing ยท Child document ยท Outgoing linkPackage publishingReleasing ยท Child document ยท Outgoing linkReleasingSentry ยท Child document ยท Outgoing linkSentryTesting the app environment ยท Child document ยท Outgoing linkTesting the app environmโ€ฆLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentLinked document ยท Outgoing linkLinked documentWorking on SeedWorking on Seed
Citations 0Children & links 19

Loading child documentsโ€ฆ

Connections show where other documents or comments link to this document.

Related documents

Loading connectionsโ€ฆ