9
Home
Peter Harpending edited this page 2025-10-18 13:30:31 -07:00

Gajumaru Wiki: Home

Contents

IT Support

Serialization

  • API Encoding: ak_... etc garbage explained
  • BaseN: Given xy_ABCD, what is the ABCD
  • RLP: If the binary ABCD is some data with fields (e.g. a transaction), how to destructure the binary data to fields
  • Serializations: Conventions for field order in Gajumaru data structures

Principles

  • PICTURES: ~Every article should have a "YouTube Thumbnail" diagram at the top that visually illustrates whatever is explained in the page

  • QUICKREF: Every page should have a "I just need to get a thing to work and don't have time to read a whole article" section that links to which things you should just use in practice and maybe a short example of how to use them.

  • DEMOS DEMOS DEMOS: Things should be illustrated with code examples that work when possible

  • CENTRALIZE: All public technical documentation should be on this wiki, not in a billion separate repos.

  • LINK: Provide receipts; i.e. whenever possible, provide a permalink reference to whatever code actually does the thing you're talking about. For instance, the API Encoding page should link to gmser_api_encoder source code whenever it makes sense to do so.

    Part of the goal of this wiki is to acquaint newcomers with the actual gajumaru codebase and to demystify it.

  • VIDEO: If it's something that is conceptually complicated, maybe make/link a video explainer

TODOs

  • Move links to aeternity things to QPQ repos
  • Articles needed:
    • Install Erlang/zx
    • GRIDS
    • QHL
  • Existing Articles:
    • API-Encoding:
      • needs practical reference (which functions to call)
      • maybe could use a diagram
    • BaseN:
      • needs practical reference
      • don't link to things in aeternity repos
    • RLP:
      • practical reference
      • don't link to aeternity repos
    • Serializations:
      • write
      • need exhaustive reference