tmeftah / Aora

Aora is an application designed to leverage AI for advanced document handling and natural language processing. This repository contains both backend and frontend components to get the application up and running.
GNU General Public License v3.0
3 stars 0 forks source link

documentation #32

Closed tmeftah closed 1 month ago

tmeftah commented 1 month ago

@NikhilRaikar17 The documentation issue will be an issue that we will not close at all. It will be all the time on progress. we will create only one branch for it. each time oen of us want to add some hing to the documentaion branch, he pull write what every he have to write and then push. every time we checkout this branch we have to pull the last develop into it. Pull request will be done when every we want? Let me know if you have also an idea hoe to do it in another way.

NikhilRaikar17 commented 1 month ago

If we have a seperate documentation branch, this branch has to be constantly updated with new changes in develop else we will have merge conflicts and to resolve them would be a waste of time as this branch does not serve any purpose.

Instead, why dont we follow the same process for the documentation aswell but without reviews.

  1. Create approrpiate issue for the documentation "as and when needed".
  2. Merge this branch once the documentation is done
  3. No need to request for any reviews from either of us
  4. We keep the steps clear and concise by not changing anything.
  5. If its a very small change in documentation, just add a commit directly into the develop but address the commit message with "Docu-Update:" (no need to create an issue and a branch for small documentation updates)

What would you think about this?

tmeftah commented 1 month ago

ok i agree now.