ObolNetwork / ObolNetwork/obol-docs
Update cluster config schema to 1.4.0 or newer
Open
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 docs have a schema that is maybe two versions old https://docs.obol.tech/docs/next/charon/cluster-configuration#cluster-definition-file
Proposed Solution
Update the docs to reflect the latest schema version. If this ticket is delayed until https://github.com/ObolNetwork/charon/issues/1645 is complete, have it reflect that version.
- The docs pages are updates
- The swagger API spec is updated
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 with the linked cluster-definition documentation page and check issue #1645 if the work is delayed. Update the documentation pages and Swagger API spec to the applicable schema version, then verify both reflect the same version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100