From 1cbcb6621752a2f7c1a5669ebee5d83f5f7d6a50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20de=20Alba?= Date: Wed, 24 Apr 2024 19:39:10 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Steve Piercy --- docs/source/contributing/developing-core.md | 37 +++++++++++---------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/docs/source/contributing/developing-core.md b/docs/source/contributing/developing-core.md index 5d41482677..f3e28f67a4 100644 --- a/docs/source/contributing/developing-core.md +++ b/docs/source/contributing/developing-core.md @@ -289,57 +289,60 @@ Used by Volto, you can also use it in other JavaScript frameworks and environmen ## Supported frameworks Plone supports several frontend implementations, the main one being Volto as the default frontend and reference React-based implementation. -The others are currently under heavy development, marked as experimental and for now, they remain as a proof of concept. + +Other frontends are currently under heavy development. +They are marked as experimental and, for now, they are a proof of concept demonstrating that other frontends are possible. Although they do work now in an acceptable way, the implementation might change in the future. -Please note that these implementations only show how to access the public Plone content in the current site and dealing with data fetching and routing. -They use the Plone Frontend Strategic Packages (`@plone/registry`, `@plone/client`, `@plone/components`, etc). +These implementations only show how to access the public Plone content in the current site, dealing with data fetching and routing. +All implementations are located in the `apps` directory in a subdirectory according to their implementation name. +They use the Plone frontend strategic packages, including `@plone/registry`, `@plone/client`, and `@plone/components`. ### Plone The default frontend and reference React-based implementation in Plone is Volto. -In the `apps` folder you'll find a Volto project scaffolding that uses Volto as a library. +In the `apps` folder, you'll find a Volto project scaffolding that uses Volto as a library. This is the same as the one that you'll have when running the Volto generator or `cookiecutter-plone-starter`. ### Next.js -This is the proof of concept using Next.js with Plone. +This frontend is a proof of concept using Next.js with Plone. -You can try it out using: +You can try it out using the following command. -``` +```shell pnpm --filter plone-nextjs dev ``` ### Remix -This is the proof of concept using Remix with Plone. +This frontend is a proof of concept using Remix with Plone. -You can try it out using: +You can try it out using the following command. -``` +```shell pnpm --filter plone-remix dev ``` ### Vite build (client only) -This is the proof of concept using a custom client build based in Vite with Plone. -It uses `@tanstack/router` in combination with `@plone/client` (which in turns uses `@tanstack/query`). +This frontend is a proof of concept using a custom client build based in Vite with Plone. +It uses `@tanstack/router` in combination with `@plone/client`, which in turns uses `@tanstack/query`. This build is suitable for applications that do not need server side generation, and it's client only. -You can try it out using: +You can try it out using the following command. -``` +```shell pnpm --filter plone-vite dev ``` ### Vite SSR build -This is the proof of concept using a custom build based in Vite with SSR with Plone. +This frontend is a proof of concept using a custom build, based in Vite with SSR with Plone. It uses `@tanstack/router` in combination with `@plone/client` (which in turns uses `@tanstack/query`). -You can try it out using: +You can try it out using the following command. -``` +```shell pnpm --filter plone-vite-ssr dev ```