zebedeeio / zbd-docs

Documentation for the ZBD API
https://zbd.dev
4 stars 10 forks source link

Documentation revamp: migrate general API Reference endpoints from docs.zebedee.io to Mintlify codebase #2

Closed andrerfneves closed 1 year ago

andrerfneves commented 1 year ago

This is the sibling issue of https://github.com/andrerfneves/zbd-docs/issues/1.

We are migrating our content from our own documentation system built on docusaurus to one in Mintlify. We

We need someone to copy the contents of every one of the API Reference documents in the docs.zebedee.io THE API REFERENCE, and port over to this codebase.

Start here: https://docs.zebedee.io/api/intro

Basically, need to port over every page/endpoint from inside https://docs.zebedee.io/api/intro over to this codebase. In individual pages (as expected by Mintlifly)

The idea is to maintain the same content structure, just make it available within this new Mintlify kit/setup. The contents should be the same and use the best capabilities from Mintlify's systems

andrerfneves commented 1 year ago

/bounty 100

algora-pbc[bot] commented 1 year ago

💎 $100 bounty created by andrerfneves 🙋 If you start working on this, comment /attempt #2 to notify everyone 👉 To claim this bounty, submit a pull request that includes the text /claim #2 somewhere in its body 📝 Before proceeding, please make sure you can receive payouts in your country 💵 Payment arrives in your account 2-5 days after the bounty is rewarded 💯 You keep 100% of the bounty award 🙏 Thank you for contributing to zebedeeio/zbd-docs!

Attempt Started (GMT+0) Solution
🟢 @rishi-raj-jain Aug 7, 2023, 11:04:46 AM #4
🔴 @Ashutosh-Bhadauriya Aug 7, 2023, 7:27:27 AM WIP
Ashutosh-Bhadauriya commented 1 year ago

/attempt #2

Options
rishi-raj-jain commented 1 year ago

@andrerfneves I'd love to do this, @Ashutosh-Bhadauriya I see you already attempting the other issue. Can I take this one?

@andrerfneves what do you think?

/attempt #2

Options
algora-pbc[bot] commented 1 year ago

Note: The user @Ashutosh-Bhadauriya is already attempting to complete issue #2 and claim the bounty. If you attempt to complete the same issue, there is a chance that @Ashutosh-Bhadauriya will complete the issue first, and be awarded the bounty. We recommend discussing with @Ashutosh-Bhadauriya and potentially collaborating on the same solution versus creating an alternate solution.

rishi-raj-jain commented 1 year ago

it's in works! lmk if I should go ahead and complete it right away 🗡️

Screenshot 2023-08-07 at 4 54 43 PM
andrerfneves commented 1 year ago

Well I know the process should be to allow for the first person that attempts it. But it seems like you're really far into it already @rishi-raj-jain. @Ashutosh-Bhadauriya are you sure going to get to it?

rishi-raj-jain commented 1 year ago

Haha yeah, I can do this! (I'm waiting for Ashutosh's reply per your message above / however you wanna proceed)

andrerfneves commented 1 year ago

@Ashutosh-Bhadauriya has claimed 3 of the bounties I've set out through Algora but he has yet to submit a PR so I'm unclear on how to proceed.

@rishi-raj-jain if you want to take this one, let's go ahead and do this before the other ticket (https://github.com/zebedeeio/zbd-node/issues/3). But let's do it!

Ashutosh-Bhadauriya commented 1 year ago

@rishi-raj-jain go ahead

andrerfneves commented 1 year ago

Thanks @Ashutosh-Bhadauriya

rishi-raj-jain commented 1 year ago

Thanks @Ashutosh-Bhadauriya & @andrerfneves I'm on it!

algora-pbc[bot] commented 1 year ago

💡 @rishi-raj-jain submitted a pull request that claims the bounty. You can visit your org dashboard to reward.

algora-pbc[bot] commented 1 year ago

🎉🎈 @rishi-raj-jain has been awarded $100! 🎈🎊