API docs

[pranshugupta54]

Looking for contributors to help build documentation

[remigathoni]

Hey @pranshugupta54 ! I'd love to contribute to the docs. Are you referring to this API Docs? Or is there a specific area you need help with?

[pranshugupta54]

Hey @remigathoni, thank you for showing interest. We are not maintaining that site, can plan to make a fresh new doc using some method for open source contribution, so anyone can help fix things.
Join us on Discord for any help.

[remigathoni]

Alright, thank you!

…

On Wed, Nov 22, 2023 at 11:00 PM Pranshu Gupta ***@***.***> wrote: Hey @remigathoni <https://github.com/remigathoni>, thank you for showing interest. We are not maintaining that site, can plan to make a fresh new doc using some method for open source contribution, so anyone can help fix things. Join us on Discord <https://digitomize.com/discord> for any help. — Reply to this email directly, view it on GitHub <#272 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMMBYTSD3CPAHLHAPQFWEQ3YFZKV5AVCNFSM6AAAAAA7UHMJKCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRTGQZTGNRZGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[pranshugupta54]

@remigathoni, we'll be working on https://github.com/digitomize/api-docs, hosted at https://doc.digitomize.com

[remigathoni]

Got you, I'll get started on it. I think I can create a docs contribution guide(I couldn't find it) first on how to set everything up as I do so myself.

edit: removed a question, I found the ans :)

[pranshugupta54]

What exactly do you mean by contribution guide? bcuz we already have README for the repo, also separate for frontend and backend. We're building docs for backend endpoints yes

[remigathoni]

Yes, I saw those and went through them! They were very helpful. I was thinking of putting together a guide for contributors to the docs specifically, like how to set up GitBook and preview the api docs locally before pushing changes etc. It could be handy for tech writers who want to jump in. What do you think?

…

On Fri, Nov 24, 2023 at 2:25 PM Pranshu Gupta ***@***.***> wrote: What exactly do you mean by contribution guide? bcuz we already have README for the repo, also separate for frontend and backend. We're building docs for backend endpoints yes — Reply to this email directly, view it on GitHub <#272 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMMBYTRGLRBKBQHWYXH5D6TYGB7ZBAVCNFSM6AAAAAA7UHMJKCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRVGUZTGMJYGU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[pranshugupta54]

That's a good idea, but at first we should build a basic API doc atleast

[remigathoni]

Got you!

…

On Sat, Nov 25, 2023 at 12:58 AM Pranshu Gupta ***@***.***> wrote: That's a good idea, but at first we should build a basic API doc atleast — Reply to this email directly, view it on GitHub <#272 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMMBYTSEPBNA4H4IMI2LC5TYGEKA5AVCNFSM6AAAAAA7UHMJKCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRWGEYDKOBSHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.