Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Switch to GitLab Next
  • Sign in / Register
AnyHedge Library
AnyHedge Library
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 24
    • Issues 24
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 2
    • Merge Requests 2
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Security & Compliance
    • Security & Compliance
    • Dependency List
    • License Compliance
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GeneralProtocols
  • AnyHedge
  • AnyHedge LibraryAnyHedge Library
  • Issues
  • #134

Closed
Open
Opened Aug 13, 2020 by Rosco Kalis@rkalisMaintainer

Clear path from a dev landing on the website to them using AnyHedge

Our objective is for a JS dev to be able to land on our website (coould be NPM package website, but ideally AnyHedge.com), and have a clear path on getting from there to creating their first AnyHedge contract.

On the AnyHedge website we have a section Getting Started > Developers, I suspect that these interested developers will be able to find their way there pretty easily. Currently that links to our GitLab group, which I think is too broad. Instead we should link (probably) to the NPM page or (maybe) to the specific AnyHedge library repo. Whichever we link to, the README will be exactly the same.

In this README we already have clear installation instructions. We also have an example in the examples repository. What we still need is clear reference to that example code and a clear explanation of it. Besides we need to have instructions for the user to set up a new Node project, install the required dependencies (also things like bitbox or libauth), and copy over the example from our repo. That way the developer has everything they need in their own repo, and can start changing the example code to their liking in their own environment.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: GeneralProtocols/anyhedge/library#134