[Update] Week #14 - Latest Documentation-Hub


#1

Latest Documentation-Hub Updates

Description

In week 14 I’ve been mainly focused on building a name registration demo aepp from scratch together with Philipp Piwo, one of æternity’s developers. The main goal of this hackathon session was to get in touch with the pain points of building aepps in top of aeternity with the help of all existing tools, investigate and document them while developing to be able to solve them afterwards. Here are my notes regarding to the pain points while developing the demo aepp. Besides that I was solving and closing open issues, mainly broken URL paths.


Here are my notes regarding to my personal experienced aepp development pain points:

  • TUTORIAL: How to Register and Update a Name with the SDK in Javascript

    instead of:

    const publicKey = 'REPLACE_WITH_PUBLIC_KEY';
    
    const client = await Universal({
    
        url: 'https://sdk-testnet.aepps.com', //replace with https://sdk-mainnet.aepps.com for mainnet
        internalUrl: 'https://sdk-testnet.aepps.com', //replace with https://sdk-mainnet.aepps.com for mainnet
        keypair: {
        publicKey: publicKey,
        secretKey: 'REPLACE_WITH_PRIVATE_KEY'
        },
        networkId: 'ae_uat', //replace with ae_mainnet for mainnet
        nativeMode: true
    });
    

    write this:

    // add main function
    const main = async (name) => {
    
        const publicKey = 'ak_sToLENWScQXMjVwCBfQebwzp8RqDi8DHrvfEQqhEgUr552X4V';
    
        const client = await Universal({
        url: 'https://sdk-testnet.aepps.com', //replace with https://sdk-mainnet.aepps.com for mainnet
        internalUrl: 'https://sdk-testnet.aepps.com', //replace with https://sdk-mainnet.aepps.com for mainnet
        keypair: {
            publicKey: publicKey,
            secretKey: '0e0b5cc0106b840eaafee695bd23261eea0bd6df483086bdd5bcf909ac00925e72948b903ffd72776f365ecff7e166fb71f3958487ffbb4ff8a6699a0122e063'
        },
        networkId: 'ae_uat', //replace with ae_mainnet for mainnet
        nativeMode: true
    });
    
    
  • structure of SDK documentation needs to be more explained and better guided for developers

  • https://github.com/aeternity/aepp-sdk-js/tree/develop/examples/connect-two-ae/identity needs to be more highlighted as a very important and useful part of any kind of aepp development for the base aepp

  • JS-SDK:

    • general missing explanations regarding to each functionality of the SDK
  • Documentation Hub:

    • write documentation about documentation hub for other contributors

References and Relevant Links

Community

Please feel free to write a forum post for feedback, requests or questions anytime. Don’t forget that I’m building this all for you and for a better experience for us all at the end :slight_smile:


Week #14 - Aeternity Product Development Coordinators Weekly Update