ObolNetwork / ObolNetwork/obol-docs
add docs for builder-api feature
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 27
- Forks
- 61
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 2
Description
🎯 Problem to be solved
Our current docs (v0.16.0) doesn't contain instructions for users to run builder-api.
🛠️ Proposed solution
Adds docs on how to enable builder-api feature in CDVN repo. This should be done after docs v0.16.0 is released as the feature only works with pregenerated registrations which will be released in v0.17.0.
🧪 Tests
- Netlify deployment build tests passing
👐 Additional acceptance criteria
❌ Out of Scope
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the current v0.16.0 documentation and the existing references to builder-api and pregenerated registrations in the Obol docs repository. Confirm the feature is available for the v0.17.0 documentation, add instructions for enabling and running builder-api, and verify that the Netlify deployment build passes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100