Add Documentation

[pankaj-bind]

Documentation is missing, without any proper documentation it is hard to setup project in our system.
Assign me this task under GSSoC'24, I will implement it.

[SanjanaBankar]

Hello,

Upon reviewing the current README for RapiDoc, I've identified opportunities to enhance engagement, informativeness, and user-friendliness. To address this, I propose restructuring content with clear headings, concise descriptions, and visually appealing formatting. Additionally, emphasizing engagement with clear instructions for contributions and feedback will make a more collaborative environment. Integrating relevant visual assets such as images or diagrams will effectively showcase RapiDoc's capabilities.

I'm looking forward to the opportunity to contribute to the RapiDoc platform. If possible please assign me this task under GSSoC24.

[Anishkagupta004]

Assigning

[SanjanaBankar]

Assigning

Hello, can you please update the assignees so that I can start working?

[kanikaa-3018]

hey pls assign me this project for GSSoc'24

[MoonStar05]

Hello
I am a GSSoC'24 contributor and looking forward to work on this

[TejaswiKandunuri]

@Anishkagupta04, I am ready to do this documentation work on Rapidoc health care website for you. please assign this work to me.

[varshith257]

@pankaj-bind Are you willing to add a separate documentation or just add setup process in README?

[varshith257]

@SanjanaBankar Are you willing to work on this?

[SanjanaBankar]

@SanjanaBankar Are you willing to work on this?

Hello, @varshith257 I already have a prior issue lined up, It would be great if other interested contributors work on this.

[varshith257]

@TejaswiKandunuri Are you willing to work on this?

[TejaswiKandunuri]

@TejaswiKandunuri Are you willing to work on this?

Yes, i am willing to work on this

[TejaswiKandunuri]

Thank you, i will start working on it.

[varshith257]

@TejaswiKandunuri Any progress on this work?

[TejaswiKandunuri]

Hi, Do you have any template for documentation or should i take some other template and work on it?

…

On Thu, 23 May 2024 at 5:43 PM, Vamshi Maskuri ***@***.***> wrote: @TejaswiKandunuri <https://github.com/TejaswiKandunuri> Any progress on this work? — Reply to this email directly, view it on GitHub <#9 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2OD2YZHA3ENRKI2TVQRUADZDXMOHAVCNFSM6AAAAABHPOTKGOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRWHE2TOMRSGY> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[varshith257]

Hi,
Do you have any template for documentation or should i take some other
template and work on it?

No specified. If you have any in your mind post here, let's evaluate of selection of template

[TejaswiKandunuri]

Please take a look at these sections that I am considering including in the documentation.
RAPIDOC-HEALTHCARE-WEBSITE
Documentation Table of Contents
1.Project Overview
2.Objectives
3.Purpose
4.Features
5.Technology Stack
6.Architecture
7.Installation (Prerequisites, Setup)_
8.Usage
9.Advantages
10.Disadvantages
11.Future Scope
12.Conclusion

[varshith257]

@TejaswiKandunuri It seems good with them. Go ahead 🚀

[TejaswiKandunuri]

Thanks, I will.

…

On Fri, 24 May 2024 at 7:06 PM, Vamshi Maskuri ***@***.***> wrote: @TejaswiKandunuri <https://github.com/TejaswiKandunuri> It seems good with them. Go ahead 🚀 — Reply to this email directly, view it on GitHub <#9 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2OD2YZXWZ54AFYW5SIE5PTZD466JAVCNFSM6AAAAABHPOTKGOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRZGU2TMMRYGQ> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[TejaswiKandunuri]

@varshith257 I added documentation. please take a look and kindly add GSSOC points.