Skip to content

Docs: Add links to Arbitrum Chain SDK and automated deployment guides in README #204

Description

@Cripto5588

Description
The README lacks direct links to arbitrum-chain-sdk and automated deployment guides, forcing developers to search external sources for programmatic bridge deployment.
Evidence (Quick Verification)
Current README links: Generic docs, manual deployment guide, audits, socials. ✅
Missing but critical links:
Chain SDK repo: github.com/OffchainLabs/arbitrum-chain-sdk
SDK deployment guide: docs.arbitrum.io/.../deploying-token-bridge
Code examples: arbitrum-chain-sdk/examples/*
Reproduce: Read "Deployment" section → only manual/CLI instructions → no mention of SDK-based automation → developer must search externally.
Expected Behavior
README should include an "Automated Deployment" section with:
Link to arbitrum-chain-sdk repo
Link to official SDK deployment guide
Reference to ready-to-use code examples
Impact
Friction for devs seeking programmatic integration
Risk of using outdated third-party tutorials
Repetitive support queries avoidable with better docs navigation
Conclusion
The information exists, but there's no documentary bridge between token-bridge-contracts and arbitrum-chain-sdk. This creates a clear developer experience gap.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions