Documentation improvements [retroactive]

[rickstaa]

Overview

To improve the developer experience we want the community to help us apply a suite of improvements to the documentation.

---

Required Skillset

• Familiarity with Node JS.
• Experience with Mintlify.

---

Bounty Requirements

The bounty hunter should implement the following list of documentation improvements:

• Since we rebranded the AI subnet to the Livepeer AI network all mentions of the AI subnet should be replaced by just Livepeer AI Network in the Livepeer AI documentation.
• Since we are now public, remove all alpha mentions.
• Add documentation for the new Segment Anything 2 pipeline (see Segment anything 2 pipeline image livepeer/ai-worker#185).
• Add Orchestrator and Gateway Metrics to documentation under AI Metrics under the Gateay and Orchestrator start-gateway and start-orchestrator pages.
  • The metrics explanation are found here, here and here.

Scope Exclusions

---

Scope Exclusions

---

Implementation Tips

Please checkout the Mintlify, NodeJS and NVM documentation to understand how to update and preview the documentation.

---

How to Apply

1. Express Your Interest: Comment on this issue to indicate your interest and explain why you're the ideal candidate for the task.
2. Wait for Review: Our team will review expressions of interest and select the best candidate.
3. Get Assigned: If selected, we'll assign the GitHub issue to you.
4. Start Working: Dive into your task! If you need assistance or guidance, comment on the issue or join the discussions in the #developer-lounge channel on our Discord server.
5. Submit Your Work: Create a pull request in the relevant repository and request a review.
6. Notify Us: Comment on this GitHub issue when your pull request is ready for review.
7. Receive Your Bounty: We'll arrange the bounty payment once your pull request is approved.
8. Gain Recognition: Your valuable contributions will be showcased in our project's changelog.

Thank you for your interest in contributing to our project! 💛

Warning

Please wait for the issue to be assigned to you before starting work. To prevent duplication of effort, submissions for unassigned issues will not be accepted.

[EAsuperstar]

I'm Interested in this, I'd like to handle it if you don't mind.

[EAsuperstar]

Completed, please review pull request #636

[EAsuperstar]

@rickstaa Please could you review my recent pull request with a commit carrying the Orchestrator and Gateway metrics documentation you requested. Thanks.

[JJassonn69]

Bounty has successfully completed. Closing it here.