palmaresHQ / palmares

A Javascript and Typescript framework aimed at unification.
MIT License
36 stars 2 forks source link

[All Packages and Libs] - Documentation, each documentation should live in it's own package, create a root `docs` folder that we can attach Docusaurus to #8

Open nicolasmelo1 opened 1 year ago

nicolasmelo1 commented 1 year ago

The documentation of the framework is modular and distributed.

This means that the main documentation should live on packages/core. Each module should document itself. packages/database, packages/test, packages/server each one of them should have it's own docs folder where it will contain the documentation. How to use, api reference and everything else.

For the adapters as well, each adapter like libs/redis-emitter, libs/express-server and so on should also document itself.

Good to have: Add the ability to attach documentation for each remote adapter. Let's say Elysia create it's own adapter, can we attach this to our documentation without manually forking their code? If we can't, just link it.

PLEASE, PLEASE, let's add WebContainers for the documentation. This way the user will be able to run the code on their browser, we can have a LIVE documentation, where the user can test everything we show him directly on the browser. It'll be awesome.

nicolasmelo1 commented 1 year ago

I think this should be splittted for each package, first we can create the core, the main entrypoint for the documentation, then we will need to create documentation for everything else and we create a task for every package.