gofractally / psibase

Open source protocol enabling communities to easily self-host web applications
https://docs.psibase.io
MIT License
28 stars 7 forks source link

Package docs update #878

Closed James-Mart closed 1 month ago

James-Mart commented 1 month ago

Background

The package docs in /doc/psidk/src/development/services/rust-service/package.md do not clearly specify which package properties can/should/must appear in which crate, for multi-crate packages.

Scope

The following rules should be added to the aforementioned package.md document:

Package root crate

If the following fields are used at all, they must appear in the package root crate:

Package service crate

If the following fields are used at all, they must appear in a package service crate:

Any crate

The following fields can be found in any crate, and the resulting package will union the definitions across all crates:

CC @swatanabe

swatanabe commented 1 month ago

They aren't organized by where they need to appear, but the descriptions mostly do specify where they are allowed.

cool-ant commented 1 month ago

What is the service field mentioned in the "service crate" section? @James-Mart

James-Mart commented 1 month ago

What is the service field mentioned in the "service crate" section? @James-Mart

What service field? 😉