Rework the documentation flow

[riderx]

The current documentation is not clear for users and would need to be re-ordered and cleaned. The goal is to help to achieve the AHA moment of Capgo and doc has to improve it. Then the doc has to be interesting for advanced users

[riderx]

/bounty 200

[algora-pbc[bot]]

💎 $200 bounty created by riderx 🙋 If you start working on this, comment /attempt #106 to notify everyone 👉 To claim this bounty, submit a pull request that includes the text /claim #106 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 ℹ️ If something is not clear ask before working on it, otherwise your chance to rework it is high 🎥 To claim you need to provide in your PR a demo video of the change 👨‍👩‍👧‍👦 Join the Discord to get help 📏 Check all Bounty rules 🙏 Thank you for contributing to Cap-go/website!

Attempt	Started (GMT+0)	Solution
🔴 @Ashutosh-Bhadauriya	Aug 17, 2023, 4:12:08 PM	WIP
🔴 @rishi-raj-jain	Aug 17, 2023, 4:17:23 PM	WIP
🔴 @anikdhabal	Sep 28, 2023, 4:51:12 PM	WIP
🟡 @WcaleNieWolny	Oct 5, 2023, 7:43:25 AM	#143

[Ashutosh-Bhadauriya]

@riderx I would like to take this /attempt #106

Options

• Cancel my attempt

[rishi-raj-jain]

@riderx

/attempt #106

Options

• Cancel my attempt

[algora-pbc[bot]]

Note: The user @Ashutosh-Bhadauriya is already attempting to complete issue #106 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]

I'm taking off myself on this. In case you feel like not doing / passing this, @Ashutosh-Bhadauriya do lmk.

[riderx]

Someone on Twitter shared about this: https://diataxis.fr/ it seems a good way to structure documentation

[Ashutosh-Bhadauriya]

@riderx I went through the capgo docs. Are you sure only the restructuring would help. I think we need to redo some content here too.

And why not go with mintlify instead of docusaurus. Its just bettter.

Here are some of the docs I really like, not related to capgo though, maybe some inspiration can be taken from them. https://resend.com/docs/introduction https://trigger.dev/docs/documentation/introduction https://infisical.com/docs/documentation/getting-started/introduction

[rishi-raj-jain]

@Ashutosh-Bhadauriya

FYI

https://capgo.app/docs/ are on https://starlight.astro.build a docusarus like project by Astro

[riderx]

@Ashutosh-Bhadauriya yes you are totally right there a lot to do. For the tech stack @rishi-raj-jain did the migration a week ago, and i'm pretty satisfied for now, so let's keep it like that for now.

[WcaleNieWolny]

@Ashutosh-Bhadauriya when improving the docs self hosting could be improved. There is no mention how to start edge functions (as far as I know) and no mention on how to use cli and plug-in with self hosted capgo and how to use S3 (note: minio will not work by default)

[riderx]

@WcaleNieWolny can you create issue i will do a bounty

[WcaleNieWolny]

I will do that later today (in about 5h)

[WcaleNieWolny]

https://github.com/Cap-go/website/issues/110

[algora-pbc[bot]]

@Ashutosh-Bhadauriya: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[algora-pbc[bot]]

@rishi-raj-jain: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[rishi-raj-jain]

@WcaleNieWolny working on this?

[WcaleNieWolny]

No I am not, I have revived my bounty for S3 docs

[WcaleNieWolny]

Feel free to take this

[algora-pbc[bot]]

The bounty is up for grabs! Everyone is welcome to /attempt #106 🙌

[algora-pbc[bot]]

The bounty is up for grabs! Everyone is welcome to /attempt #106 🙌

[anikdhabal]

/attempt #106

Options

• Cancel my attempt

[algora-pbc[bot]]

@anikdhabal: Reminder that in 5 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[WcaleNieWolny]

@anikdhabal what is the status of your attempt? I would love to attempt this if this is available

As a contributor to the capgo project I know a lot about and and it would be relatively easy for me to document the project and all the different features that we have available

[anikdhabal]

@anikdhabal what is the status of your attempt? I would love to attempt this if this is available

As a contributor to the capgo project I know a lot about and and it would be relatively easy for me to document the project and all the different features that we have available

Yes @WcaleNieWolny. I am taking off myself. You can try

[WcaleNieWolny]

Thanks a lot 🙏

/attempt #106

Options

• Cancel my attempt

[WcaleNieWolny]

here is the list of articles I think would be beneficial to add:

• CI/CD integration
• AB testing (how to enable and use AB testing)
• Progressive deploy (@riderx progressive deploy even work or was it disabled?)
• Selecting disabling update strategy
• Add contributing guidelines (link contributing.md)
  • Fix misleading information in existing tutorials + fix typos

[algora-pbc[bot]]

@WcaleNieWolny: Reminder that in 5 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[algora-pbc[bot]]

💡 @WcaleNieWolny submitted a pull request that claims the bounty. You can visit your org dashboard to reward.

[riderx]

/approve

[algora-pbc[bot]]

🎉🎈 @WcaleNieWolny has been awarded $200! 🎈🎊