edk12564 opened a new pull request, #120:
URL: https://github.com/apache/fineract-consumer-facing/pull/120

   Issues: https://github.com/apache/fineract-consumer-facing/issues/118
   
   # Summary
   
   In order to onboard contributors quickly, we should add extensive 
documentation on the app and best practices. An adoc book for frontend and 
backend, along with asciidoctor was utilized to render the book on a webpage. 
   
   To render the docs, simply run:
   
   Backend for Frontend:
     ./gradlew :docs:asciidoctor
     open ../docs/build/docs/html/index.html
   
   Frontend:
     ./gradlew :docs:asciidoctorFrontend
     open ../docs/build/docs/html-frontend/index.html
   
   from /consumer.
   
   On top of adocs, plant UML was used for diagrams. 
   
   Finally, the README.md was updated to include instructions on how to render 
the docs, along with updated file structure.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to