Skip to content

Update tutorial(s) in docs #320

Closed

Description

@krisbitney

Our documentation contains a tutorial for creating wraps https://docs.polywrap.io/tutorials/create-wraps/tutorial/project-setup

The tutorial asks users to clone and modify a wrap located in our deprecated demos repo. It also uses ENS URIs, which we have moved away from in favor of IPFS and Wrapscan URIs.

We should replace the tutorial with a new, updated, simpler one. Instead of modifying an existing wrap, the tutorial should start with npx polywrap create and create a new wrap.

Activity

  1. self-assigned this
    on Oct 20, 2023
  2. krisbitney commented on Oct 23, 2023

    @krisbitney
    ContributorAuthor

    Outline: Create Wraps Tutorial

    Part 1: Everything you need to be productive

    • Prereqs, installation
    • setup -> npx polywrap create … & Overview of project folder contents
      • polywrap manifest
      • schema
      • testing
    • Project manifest
    • Schema and codegen overview
      • Schema type Module {}
      • Custom types
    • Write a function with a custom type & build with defaults
      • add function to schema and run codegen
      • write function
      • build
    • Imports: import a wrap and write a function
      • URIs
      • Subinvoke
    • Working with interfaces: import an interface and write a function
      • Why interfaces?
      • How do interfaces work?
      • getImplementations
      • Use case: plugins and interfaces
        • interfaces allow plugins in different languages to be invoked with the same URI and interface
    • Testing: integration tests
      • use default client config and link to its docs
      • We won’t use workflows in this tutorial
    • Add metadata
      • Add a readme
    • Deploy to IPFS with default deploy manifest

    Part 2: Extras (continues from part 1)

    • Overview of default client config
    • Configure build manifest
      • build strategies
      • custom options
      • custom docker images
    • Configure deploy manifest
      • deploy to custom targets
    • Configure the infra manifest
      • default eth-ens-ipfs module
      • custom modules
    • Configure the docs manifest
    • Testing with workflows
      • why workflows?
      • custom client config
  3. krisbitney commented on Oct 31, 2023

    @krisbitney
    ContributorAuthor

    Created another issue for part 2 of the tutorial: #329

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

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