Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ai): add ai-subnet documentation #549

Draft
wants to merge 49 commits into
base: main
Choose a base branch
from
Draft

docs(ai): add ai-subnet documentation #549

wants to merge 49 commits into from

Conversation

rickstaa
Copy link

This draft contains the AI subnet documentation.

This commit adds documentation on how Orchestrators can broadcast
their AI subnet service URIs to AI subnet Gateways, enabling their
discovery on the subnet for job execution.
This commit improves the subsection titles and Discovery text.
This commit adds a guide on how AI nodes can advertise their AI URI
using the Arbitrum explorer.
This commit adds an initial draft for the AI Subnet API reference. It is
not yet linked to an upstream API endpoint so the playground is not yet
working.
@rickstaa rickstaa marked this pull request as ready for review April 19, 2024 11:41
@rickstaa rickstaa marked this pull request as draft April 19, 2024 11:41
rickstaa and others added 12 commits April 19, 2024 18:48
This commit adds the initial draft for the documentation that explains
the pipelines available on the network.
This commit ensures that images are working when deployed on the remote.
This commit replaces the relative image paths used in the pipelines
documentation with external paths. We can change this back if we found a
way to use relative paths inside mermaid graphs.
This commit adds a general scaffold for the contribution pages. It is a
quick draft and should not yet be published to the upstream docs.
This commit adds a general scaffold for the contribution pages. It is a
quick draft and should not yet be published to the upstream docs.
This commit improves the AI subnet introduction page.
This commit ensures that the collaboration card is linked correctly.
This commit improves the styling used in the pipeline mermaid
diagrams.
This commit updates the pipelines documentation to increase
readability.
This commit implements a temporary solution to address the issue of
images not displaying correctly when embedded in a mermaid graph on the
deployed site. Can be replaced with relative path if mintlify fixes the
issue (see
https://mintlify-users.slack.com/archives/C05D00NS55F/p1714485030542069).
This commit adds a small disclaimer to the API documentation that states
that the livepeer.cloud API is not production ready.
This commit adds the orchestrator setup guide.
@rickstaa rickstaa changed the title docs(ai): add on-chain discovery documentation docs(ai): add ai-subnet documentation May 1, 2024
This commit improves the descriptions of the projects in the showcase.
This commit highlights some keywords in the showcase descriptions.
This commit adds the documentation for setting up a AI gateway on the AI
subnet. It also improves the project structure.
This commit updates the text to reflect an impersonal writing style,
consistent with the ecosystem's voice. It eliminates personal pronouns
such as "our" and "we".
@rickstaa rickstaa mentioned this pull request May 1, 2024
rickstaa and others added 20 commits May 1, 2024 14:16
This commit fixes several broken internal links in the AI gateway docs.
This commit improves the readability of the AI subnet introduction
section.
This commit hides the contribution and SDK pages and cleansup the
pipeline pages.
This commit applies some last text formatting improvements.
This commit adds a model parameter callout to the API docs to explain
that not all parameters are used by all models.
This commit fixes some small typos.
This commit fixes some small spelling errors.
* chore(ai): fix small typo

This commit fixes some small typos.

* refactor(ai): fix spelling

This commit fixes some small spelling errors.
This commit adds the Google Analytics GA4 token to the documentation
config.
This commit makes it more clear that Gateways were formaly named
Broadcasters.
This commit simplifies the binary install of the AI subnet by giving
users one simple download url they can use to downloade the latest
`ai-video` branch binary. This was made possible in
livepeer/go-livepeer@fb9764b.
This commit applies the feedback I received from the community about
things that could be improved.

Co-authored-by: Authority_Null <95463891+AuthorityNull@users.noreply.github.com>
Co-authored-by: Chuck Chain <36555842+ChuckChain@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants