ObolNetwork / ObolNetwork/obol-docs

List the oldest supported version on our docs site

Open Beginner friendly
#138 0 comments 0 reactions 0 assignees View on GitHub

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

We will eventually need a sophisticated support policy that outlines what the oldest version we will maintain is. We also will need to stop doing backwards incompatible changes when we get to a v1.

🛠️ Proposed solution

Somewhere in the charon introduction, say the oldest supported version is v0.14 (which will be our first BSL one).

🧪 Tests

👐 Additional acceptance criteria

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the charon introduction on the docs site and locate the section describing supported versions. Add that v0.14 is the oldest supported version and the first BSL version. Done means the statement appears clearly in the published introduction; no tests are specified.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.