Skip to content

docs: Missing direct links to SDK repositories and empty wiki hinder developer onboarding #820

@Cripto5588

Description

@Cripto5588

Problem

The README references multiple SDKs (avail-js, avail-rust, avail-go) and a "wiki page", but:

  1. The SDKs are mentioned as plain text without direct clickable links to their repositories.
  2. The referenced "wiki page" (the GitHub Wiki) is currently empty or not populated, leading to a dead end for developers seeking additional guides.

Evidence:

  • README SDK section (L12-L14): https://github.com/availproject/avail/blob/main/README.md#L12-L14
  • Wiki reference (L208): https://github.com/availproject/avail/blob/main/README.md#L208

Impact

This creates unnecessary friction for new developers:

  • Requires manual searching to locate the official SDK repositories, creating uncertainty about which ones are maintained or official.
  • The empty wiki contradicts the README's promise of finding guides for "Running Light Clients" and "Synchronization options", effectively blocking developers who need this documentation.

Suggested Fix

  • For SDKs: Add direct hyperlinks to the official repositories for avail-js, avail-rust, and avail-go.
  • For the Wiki: Either (a) populate the GitHub wiki with the minimum guides for the topics listed, or (b) remove the wiki reference and replace it with a link to existing external documentation (if available).

This is a quick, high-impact improvement that will significantly reduce onboarding time for external developers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions