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 6472 tidy #6475

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Docs 6472 tidy #6475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
690fa5f
Tidy up docs from #6472
stevepiercy Nov 7, 2024
efba375
Update rr7 README.md
stevepiercy Nov 7, 2024
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
23 changes: 14 additions & 9 deletions PACKAGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ It's published "as is", so you can import the type definitions from anywhere in

## Core packages

- `@plone/registry`
- `@plone/client`
- `@plone/components`
- `@plone/registry`


### Rules
Expand All @@ -28,31 +28,36 @@ Core packages must not depend on any other `@plone/*` package, with only one exc
They must be published and bundled in a traditional (transpiled) way.
The bundle of these packages must work on both CommonJS and ECMAScript Module (ESM) environments.


## Utility packages

- `@plone/providers`
- `@plone/helpers`
- `@plone/drivers`
- `@plone/helpers`
- `@plone/providers`
- `@plone/rsc`


### Rules

Utility packages can depend on core packages and other utility packages.
They must be published in a traditional way, bundled.
They must be published in the traditional way, as a bundle.
This bundle must work on both CommonJS and ESM environments.


## Feature packages

- `@plone/blocks`
- `@plone/slots`
- `@plone/contents`
- `@plone/slots`


### Rules

Feature packages (or add-on packages) can depend on any other package.
They must not be transpiled, but as source.
They must provide a default configuration registry loader as default main entry point export.
They must be able to be loaded as any other add-on.
Feature packages, or add-on packages, can depend on any other package.
You must distribute them as source code, and not transpile them.
They must provide a default configuration registry loader as the default main entry point export.
They must be loadable as any other add-on.


## Development utility packages

Expand Down
4 changes: 2 additions & 2 deletions apps/rr7/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ This is intended to serve as both a playground for the development of both packa

## Development

To start, from the root of the monorepo:
To start, from the root of the monorepo, issue the following commands.

```shell
pnpm install
pnpm --filter plone-remix run dev
```

Then start the Plone backend:
Then start the Plone backend.

% TODO MAKEFILE
```shell
Expand Down
Loading