search

Himasnhu-AT / noterAI

NoterAI is a product for students to help them study better and efficiently
https://noterai.vercel.app
Other
4 stars 8 forks source link

[DOCS] update dev-docs #58

Open Himasnhu-AT opened 1 month ago

Himasnhu-AT commented 1 month ago

Based on recent updates / refactors, the dev docs are out of scope. update the dev docs, and give technical documentation for how this is functioning, cloning, contributing, what each package, app do so on...

PS: If you have any doubts for any section, just comment on this issue

gaurimadan commented 1 month ago

@Himasnhu-AT i would like to take this issue

Himasnhu-AT commented 1 month ago

@gaurimadan so here's a thing, currently all the docs are in md format, outdated, built using vitepress. But we are revamping frontend to microfrontend artitechture, and therefore would require you to recreate docs in nextjs. And use any current te plate of nextjs to do so.

Ensure to keep all files into dir which I'll specify later.

Is that okay? I'll let you know when I make push for you to work on