Repository navigation
docs: decision oracle guide and API reference (@ixo/decision-oracle) - #52
Closed
youssefhany-ixo wants to merge 3 commits into
Closed
youssefhany-ixo wants to merge 3 commits into
youssefhany-ixo wants to merge 3 commits into
Conversation
Partner-facing pages for the @ixo/decision-oracle npm package (how to build and run one, and the full API reference), taken from the package's guide.md and api.md with internal notes removed. Adds a Decision oracle group to the Build an Oracle nav and a card on its landing page. Notes that the oracle runs on a free workers.dev address and a custom domain is optional. Co-authored-by: Youssef Hany <youssef.hany@ixo.earth>
…nding page Co-authored-by: Youssef Hany <youssef.hany@ixo.earth>
…der plugin Co-authored-by: Youssef Hany <youssef.hany@ixo.earth>
Collaborator
Author
|
Closing: docs.ixo.world is served from ixoworld/ixo-docs, so this moved to https://github.com/ixoworld/ixo-docs/pull/10. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds public pages for the
@ixo/decision-oraclenpm package. Its npm README links to docs inside a private repo, so partners hit 404s. These pages give them somewhere public to go.What changes:
build-an-oracle/decision-oracle: the guide to building and running a decision oracle, from an empty directory to deployed, hired and signing on chain.build-an-oracle/decision-oracle/api-reference: every export, config field, binding, var, HTTP route and CLI command.workers.devaddress. A custom domain is optional.Both pages come from the package's own guide.md and api.md. I removed internal notes (owner rulings, spec and session ids, private repo paths) and pointed cross-links at these pages.
Checks: eslint (mdx) passes on the new pages. markdownlint passes.
mint broken-linksreports nothing in these files (the 17 broken links it finds were already in other pages).Order: merge this first, then release the package. The package PR sets npm's
homepageto this page: https://github.com/ixoworld/eval-oracle/pull/239 (leave it open until the docs are live)Also adds an "Easiest way: build it with your AI agent" section near the top of the guide, plus a line on the landing card, for the
ixo-oracle-builderplugin fromixoworld/ixo-plugins. Merge together with ixoworld/ixo-plugins#49: that PR is where the plugin starts on testnet by default and uses workers.dev, as this page says.