Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: bootstrap a glossary, with p/ and r/ #1043

Merged
merged 1 commit into from
Aug 10, 2023
Merged

docs: bootstrap a glossary, with p/ and r/ #1043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Glossary

<!-- TODO: generate TOC -->

## `p/` - "Pure" packages

A `p/` package denotes a "pure" package within the system. These packages are
crafted as self-contained units of code, capable of being independently imported
and utilized.

Unlike `r/` realms, `p/` packages do not possess states or assets. They are
designed specifically to be called by other packages, whether those packages are
pure or realms.

## `r/` - "Realm" packages

An `r/` realm designates a package endowed with advanced capabilities, referred
to as a "realm".

Realms can accommodate a diverse array of data and functionalities, including
Bank State, Data State, and Address.

They are purposed to furnish and expose features for both user-initiated calls
and as components invoked by other realm packages.