docs: documentation update (#33)

* docs: documentation and readme and license files review

* docs: update copyrights

---------

Co-authored-by: Rauno De Pasquale <[email protected]>

Author: raunodepasquale

.github/actions/triage/LICENSE

@@ -1,5 +1,6 @@
 MIT License
 
+Copyright (c) 2025 Newesis Srl <[email protected]>
 Copyright (c) 2024 Payload <[email protected]>. All modification and additions are copyright of Payload.
 
 ---

.github/reproduction-guide.md

@@ -61,4 +61,4 @@ Once they are installed you can open the `testing` tab in vscode sidebar and dri
 
 #### Notes
 
-The default credentials are `[email protected]` as email and `test` as password. They can be found in `test/credentials.ts`. By default, these will be autofilled, so no log-in is required.
+The default credentials are `[email protected]` as email and `test` as password. They can be found in `test/credentials.ts`. By default, these will be autofilled, so no log-in is required.

CONTRIBUTING.md

@@ -8,13 +8,13 @@ Before you submit an issue, please check all existing [open and closed issues](h
 
 ## Security issues & vulnerabilities
 
-If you come across an issue related to security, or a potential attack vector within MZinga or one of its dependencies, please DO NOT create a publicly viewable issue. Instead, please contact us directly at [`[email protected]`](mailto:[email protected]). We will do everything we can to respond to the issue as soon as possible.
+If you come across an issue related to security, or a potential attack vector within MZinga or one of its dependencies, please DO NOT create a publicly viewable issue. Instead, please contact us directly at [`[email protected]`](mailto:[email protected]). We will do everything we can to respond to the issue as soon as possible.
 
-If you find a vulnerability within the core MZinga repository, and we determine that it is remediable and of significant nature, we will be happy to pay you a reward for your findings and diligence. [`Contact us`](mailto:[email protected]) to find out more.
+If you find a vulnerability within the core MZinga repository, and we determine that it is remediable and of significant nature, we will be happy to pay you a reward for your findings and diligence. [`Contact us`](mailto:[email protected]) to find out more.
 
 ## Documentation edits
 
-MZinga documentation can be found directly within its codebase, and you can feel free to make changes / improvements to any of it through opening a PR. We utilize these files directly in our website and will periodically deploy documentation updates as necessary.
+MZinga documentation can be found directly within its codebase, and you can feel free to make changes / improvements to any of it through opening a PR. 
 
 ## Building additional features
 
@@ -32,12 +32,14 @@ To help us work on new features, you can create a new feature request post in [G
 
 ### Installation & Requirements
 
-MZinga is structured as a Monorepo, encompassing not only the core MZinga platform but also various plugins and packages. To install all required dependencies, you have to run `pnpm install` once in the root directory. **PNPM IS REQUIRED!** Yarn or npm will not work - you will have to use pnpm to develop in the core repository. In most systems, the easiest way to install pnpm is to run `corepack enable` in your terminal.
+MZinga Core is structured as a Monorepo, encompassing not only the core MZinga platform but also various plugins and packages. To install all required dependencies, you have to run `pnpm install` once in the root directory. **PNPM IS REQUIRED!** Yarn or npm will not work - you will have to use pnpm to develop in the core repository. In most systems, the easiest way to install pnpm is to run `corepack enable` in your terminal.
 
 If you're coming from a very outdated version of mzinga, it is recommended to nuke the node_modules folder before running pnpm install. On UNIX systems, you can easily do that using the `pnpm clean:unix` command, which will delete all node_modules folders and build artefacts.
 
 It is also recommended to use at least Node v18 or higher. You can check your current node version by typing `node --version` in your terminal. The easiest way to switch between different node versions is to use [nvm](https://github.com/nvm-sh/nvm#intro).
 
+We encourage you to check Mzinga Apps repository to get the full Mzinga solution, and to use our official images and Helm Charts to run the applications.
+
 ### Code
 
 Most new functionality should keep testing in mind. All top-level directories within the `test/` directory are for testing a specific category: `fields`, `collections`, etc.
@@ -65,7 +67,7 @@ The following command will start MZinga with your config: `pnpm dev my-test-dir`
 
 By default, mzinga will [automatically log you in](https://payloadcms.com/docs/authentication/config#admin-autologin) with the default credentials. To disable that, you can either pass in the --no-auto-login flag (example: `pnpm dev my-test-dir --no-auto-login`) or set the `PAYLOAD_PUBLIC_DISABLE_AUTO_LOGIN` environment variable to `false`.
 
-The default credentials are `[email protected]` as E-Mail and `test` as password. These are used in the auto-login.
+The default credentials are `[email protected]` as E-Mail and `test` as password. These are used in the auto-login.
 
 ### Testing with your own MongoDB database
 
@@ -111,14 +113,3 @@ If you are committing to [templates](./templates) or [examples](./examples), use
 ## Pull Requests
 
 For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR message.
-
-## Previewing docs
-
-This is how you can preview changes you made locally to the docs:
-
-1. Clone our [website repository](https://github.com/payloadcms/website)
-2. Run `yarn install`
-3. Duplicate the `.env.example` file and rename it to `.env`
-4. Add a `DOCS_DIR` environment variable to the `.env` file which points to the absolute path of your modified docs folder. For example `DOCS_DIR=/Users/yourname/Documents/GitHub/payload/docs`
-5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
-6. You're done! Now you can start the website locally using `yarn run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)

ISSUE_GUIDE.md

@@ -66,4 +66,4 @@ Once they are installed you can open the `testing` tab in vscode sidebar and dri
 
 #### Notes
 
-- It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `[email protected]` as email and `test` as password.
+- It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `[email protected]` as email and `test` as password.

README.md

@@ -1,62 +1,51 @@
 <p align="left">
   <a href="https://github.com/mzinga-io/mzinga-core/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/mzinga-io/mzinga-core/main.yml?style=flat-square"></a>
 </p>
-<hr/>
-<h4>
-<a target="_blank" href="https://mzinga.io/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a>
-</h4>
-<hr/>
 
-<h3>Benefits over a regular CMS</h3>
+
+<h3>The Story: Why We Forked PayloadCMS v2</h3>
+<ul>
+<li>Our journey began with a deep appreciation for PayloadCMS. The team at Newesis embraced PayloadCMS from its early days, recognizing its powerful architecture and contributing as individual developers to the open-source project. Mzinga was initially born as a suite of extensions on top of PayloadCMS version 2, adding new capabilities to an already excellent core.</li>
+<li>When PayloadCMS evolved to version 3, it introduced significant architectural changes. After careful consideration, we decided that the v2 architecture remained the ideal foundation for our vision of a highly extensible, event-driven data platform.</li>
+<li>With PayloadCMS v2 no longer actively maintained, we were at a crossroads. To ensure the long-term stability and evolution of the platform our clients and projects relied on, we made a crucial decision: we forked the latest release of PayloadCMS v2.</li>
+<li>This fork is now Mzinga Core. By taking ownership of the core, we guarantee its maintenance and evolution, allowing us to innovate while preserving the architectural principles we value. The entire Mzinga.io ecosystem—Mzinga Core, Mzinga Apps, and Mzinga Tools, is now fully open source under the new mzinga-io organization on GitHub. This is our commitment to the community and to the future of this powerful platform.</li>
+</ul>
+
+
+## The Core Concept: Dynamic, API-First Data Modeling
+
+The true power of Mzinga lies in its dynamic nature. You are not limited by a predefined schema. Instead, you can create entirely new classes of entities, or "Collections", at runtime.
+
+The process is simple and powerful:
 <ul>
-  <li>Don’t hit some third-party SaaS API, hit your own API</li>
-  <li>Use your own database and own your data</li>
-  <li>It's just Express - do what you want outside of Payload</li>
-  <li>No need to learn how Payload works - if you know JS, you know Payload</li>
-  <li>No vendor lock-in</li>
-  <li>Avoid microservices hell - get everything (even auth) in one place</li>
-  <li>Never touch ancient WP code again</li>
-  <li>Build faster, never hit a roadblock</li>
-  <li>Both admin and backend are 100% extensible</li>
+<li>Define: You design your entity structure as a JSON object, defining fields, types, and relationships.</li>
+<li>POST: You post this JSON definition to Mzinga's Custom Entities API.</li>
+<li>Publish: Once the entity is published, Mzinga’s engine automatically goes to work.<li>
+</ul>
+Instantly, the platform provisions a complete set of APIs for your new entity, with no code generation or server restarts required. You get:
+<ul>
+<li>REST APIs: A full suite of CRUD (Create, Read, Update, Delete) endpoints.</li>
+<li>GraphQL APIs: Powerful and flexible query capabilities, automatically reflecting your schema.</li>
+<li>WebSockets: Real-time data publication for any operation, enabling reactive frontend applications.</li>
 </ul>
 
-## ✨ Features
-
-- Completely free and open-source
-- [GraphQL](https://mzinga.io/docs/graphql/overview), [REST](https://mzinga.io/docs/rest-api/overview), and [Local](https://mzinga.io/docs/local-api/overview) APIs
-- [Easily customizable ReactJS Admin](https://mzinga.io/docs/admin/overview)
-- [Fully self-hosted](https://mzinga.io/docs/production/deployment)
-- [Extensible Authentication](https://mzinga.io/docs/authentication/overview)
-- [Local file storage & upload](https://mzinga.io/docs/upload/overview)
-- [Version History and Drafts](https://mzinga.io/docs/versions/overview)
-- [Field-based Localization](https://mzinga.io/docs/configuration/localization)
-- [Block-based Layout Builder](https://mzinga.io/docs/fields/blocks)
-- [Extensible SlateJS rich text editor](https://mzinga.io/docs/fields/rich-text)
-- [Array field type](https://mzinga.io/docs/fields/array)
-- [Field conditional logic](https://mzinga.io/docs/fields/overview#conditional-logic)
-- Extremely granular [Access Control](https://mzinga.io/docs/access-control/overview)
-- [Document and field-level hooks](https://mzinga.io/docs/hooks/overview) for every action Payload provides
-- Built with Typescript & very Typescript-friendly
-- Intensely fast API
-- Highly secure thanks to HTTP-only cookies, CSRF protection, and more
 
 <a target="_blank" href="https://github.com/mzinga-io/mzinga-core/discussions"><strong>Request Feature</strong></a>
 
-### TODO: rewrite the below section
 
 ## 🗒️ Documentation
 
-Check out the [Payload website](https://mzinga.io/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
+Check out the [Doc Directory](./docs) of the repo to find in-depth documentation for everything that the core solution offers.
 
-Migrating from v1 to v2? Check out the [2.0 Release Notes](https://github.com/mzinga-io/mzinga-core/releases/tag/v2.0.0) on how to do it.
 
 ## 🙋 Contributing
 
 If you want to add contributions to this repository, please follow the instructions in [contributing.md](./CONTRIBUTING.md).
 
 ## 📚 Examples
 
-The [Examples Directory](./examples) is a great resource for learning how to setup Payload in a variety of different ways, but you can also find great examples in our blog and throughout our social media.
+The [Examples Directory](./examples) is a great resource for learning how to setup Mzinga-Core in a variety of different ways, but we encourage you to test the Mzinga-Apps repo, containing the extension to the Core platform. 
+You can find the source code but also the Helm Chart to deploy the application in Kubernetes using the official images built by Newesis Srl. 
 
 If you'd like to run the examples, you can either copy them to a folder outside this repo or run them directly by (1) navigating to the example's subfolder (`cd examples/your-example-folder`) and (2) using the `--ignore-workspace` flag to bypass workspace restrictions (e.g., `pnpm --ignore-workspace install` or `pnpm --ignore-workspace dev`).
 
@@ -66,17 +55,14 @@ You can see more examples at:
 
 ## 🚨 Need help?
 
-There are lots of good conversations and resources in our Github Discussions board and our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. :point_down:
+You can open a new conversations in our Github Discussions board or create a new Issue if you identify a problem.
 
 - [GitHub Discussions](https://github.com/mzinga-io/mzinga-core/discussions)
 - [GitHub Issues](https://github.com/mzinga-io/mzinga-core/issues)
 
-### TODO: one day
 
 ## ⭐ Like what we're doing? Give us a star
 
-![payload-github-star](https://cms.payloadcms.com/media/payload-github-star.gif)
-
 ## 👏 Thanks to all our contributors
 
 <img align="left" src="https://contributors-img.web.app/image?repo=mzinga-io/mzinga-core"/>

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report any security issues or concerns to [[email protected]](mailto:[email protected]).
+Please report any security issues or concerns to [[email protected]](mailto:[email protected]).

docs/authentication/operations.mdx

@@ -82,7 +82,7 @@ Example response:
 ```ts
 {
   user: { // The JWT "payload" ;) from the logged in user
-    email: '[email protected]',
+    email: '[email protected]',
     createdAt: "2020-12-27T21:16:45.645Z",
     updatedAt: "2021-01-02T18:37:41.588Z",
     id: "5ae8f9bde69e394e717c8832"
@@ -118,7 +118,7 @@ const res = await fetch('http://localhost:3000/api/[collection-slug]/login', {
     'Content-Type': 'application/json',
   },
   body: JSON.stringify({
-    email: '[email protected]',
+    email: '[email protected]',
     password: 'this-is-not-our-password...or-is-it?',
   }),
 })
@@ -129,7 +129,7 @@ const json = await res.json()
 /*
 {
   user: {
-    email: '[email protected]',
+    email: '[email protected]',
     createdAt: "2020-12-27T21:16:45.645Z",
     updatedAt: "2021-01-02T18:37:41.588Z",
     id: "5ae8f9bde69e394e717c8832"
@@ -144,7 +144,7 @@ const json = await res.json()
 
 ```graphql
 mutation {
-  login[collection-singular-label](email: "[email protected]", password: "yikes") {
+  login[collection-singular-label](email: "[email protected]", password: "yikes") {
     user {
       email
     }
@@ -160,7 +160,7 @@ mutation {
 const result = await payload.login({
   collection: '[collection-slug]',
   data: {
-    email: '[email protected]',
+    email: '[email protected]',
     password: 'get-out',
   },
 })
@@ -213,7 +213,7 @@ const json = await res.json()
 /*
 {
   user: {
-    email: '[email protected]',
+    email: '[email protected]',
     createdAt: "2020-12-27T21:16:45.645Z",
     updatedAt: "2021-01-02T18:37:41.588Z",
     id: "5ae8f9bde69e394e717c8832"
@@ -284,7 +284,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/unlock`, {
     'Content-Type': 'application/json',
   },
   body: JSON.stringify({
-    email: '[email protected]',
+    email: '[email protected]',
   }),
 })
 ```
@@ -293,7 +293,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/unlock`, {
 
 ```
 mutation {
-  unlock[collection-singular-label](email: "[email protected]")
+  unlock[collection-singular-label](email: "[email protected]")
 }
 ```
 
@@ -303,7 +303,7 @@ mutation {
 const result = await payload.unlock({
   collection: '[collection-slug]',
   data: {
-    email: '[email protected]',
+    email: '[email protected]',
   },
 })
 ```
@@ -325,7 +325,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-pass
     'Content-Type': 'application/json',
   },
   body: JSON.stringify({
-    email: '[email protected]',
+    email: '[email protected]',
   }),
 })
 ```
@@ -334,7 +334,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-pass
 
 ```
 mutation {
-  forgotPassword[collection-singular-label](email: "[email protected]")
+  forgotPassword[collection-singular-label](email: "[email protected]")
 }
 ```
 
@@ -344,7 +344,7 @@ mutation {
 const token = await payload.forgotPassword({
   collection: '[collection-slug]',
   data: {
-    email: '[email protected]',
+    email: '[email protected]',
   },
   disableEmail: false, // you can disable the auto-generation of email via local API
 })
@@ -384,7 +384,7 @@ const json = await res.json();
 /*
 {
   user: {
-    email: '[email protected]',
+    email: '[email protected]',
     createdAt: "2020-12-27T21:16:45.645Z",
     updatedAt: "2021-01-02T18:37:41.588Z",
     id: "5ae8f9bde69e394e717c8832"

docs/local-api/overview.mdx

@@ -309,7 +309,7 @@ const result = await payload.login({
   collection: 'users', // required
   data: {
     // required
-    email: '[email protected]',
+    email: '[email protected]',
     password: 'rip',
   },
   req: req, // pass an Express `req` which will be provided to all hooks
@@ -330,7 +330,7 @@ const token = await payload.forgotPassword({
   collection: 'users', // required
   data: {
     // required
-    email: '[email protected]',
+    email: '[email protected]',
   },
   req: req, // pass an Express `req` which will be provided to all hooks
 })
@@ -364,7 +364,7 @@ const result = await payload.unlock({
   collection: 'users', // required
   data: {
     // required
-    email: '[email protected]',
+    email: '[email protected]',
   },
   req: req, // pass an Express `req` which will be provided to all hooks
   overrideAccess: true,