Skip to content

Commit

Permalink
Merge pull request #28 from permaweb/docs
Browse files Browse the repository at this point in the history
docs audit
  • Loading branch information
afisher3578 authored Jun 5, 2024
2 parents cd9c496 + 27af07f commit b3236bf
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 24 deletions.
8 changes: 4 additions & 4 deletions src/views/Docs/DocsDetail/MD/attach-udl.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
## Attach a license to your atomic assets
### Attach a license to your atomic assets

After uploading your atomic assets and configuring metadata you will proceed to the next screen to attach licensing rights to your work with the Universal Data License.

To upload an atomic asset without attaching a license, uncheck the box next to **"This asset will contain a license"**.

### What is the Universal Data License (UDL)?
#### What is the Universal Data License (UDL)?

The Universal Data License defines the terms and conditions for using media assets on the permaweb. The UDL establishes a framework for licensing digital media such as images, videos, audio, graphics and more. Instead of platforms setting the terms and conditions, on the permaweb creators define how their media can be utilized. Link to the full UDL [here](https://udlicense.arweave.dev/).

Since platforms built on the Universal Content Marketplace (UCM) protocol are in their "early" release, not all UDL parameters are currently supported. Please check with the marketplace platforms for more information about how UDL is supported on their platform.

### UDL early release
#### UDL early release

Since UDL is in its "early" release, not all UDL parameters are currently supported on Helix. Stay tuned for more updates related to UDL capabilites on Helix and other permaweb applications.

Read the UDL v.02 release blog post [here](https://mirror.xyz/0x64eA438bd2784F2C52a9095Ec0F6158f847182d9/RPzz5-8jh_eWCdqn-K51DIkk5i_gQTTmRAwdvm7OihI).

### UDL parameters
#### UDL parameters

- Access Fee - Fee a user must pay to access the content
- One time - Pay once to access content forever.
Expand Down
18 changes: 10 additions & 8 deletions src/views/Docs/DocsDetail/MD/core-concepts.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
## Core concepts
### Core concepts

#### Fundamental concepts of Helix and the permaweb
**Fundamental concepts of Helix and the permaweb.**

### Atomic asset
#### Atomic asset

An atomic asset is a unique digital item stored on Arweave. Unlike traditional NFTs, the asset data is uploaded together with a smart contract in a single transaction which is inseparable and does not rely on external components.

On other chains, the asset data, metadata, and smart contract are typically separate from each other with the smart contract linking to the other components. Atomic assets ensure that all data is stored together onchain to ensure permanence and accessibility.

#### Atomic asset collection
![Atomic Asset Collection](https://arweave.net/7kIS7I0DYscZpwhOAm75h39qqXEGQYOnbpfpH7HCSiw)

##### Atomic asset collection

Atomic asset collections are groups of atomic assets bundled together and displayed as a collection on the UCM. These collections can consist of existing atomic assets owned by the user, newly uploaded assets, or a combination of both.

![Atomic Asset Collection](https://arweave.net/bZn3OwpPCTPV6CPsrobvGvXFyF_vdwkrtj7JaK_F5fM)

### Ardrive Turbo
#### Ardrive Turbo

[Ardrive Turbo](https://ardrive.io/turbo-bundler/) is a payment service that bridges fiat currency to $AR and bundles data into larger, more efficient uploads to the Arweave network. Turbo credits are purchased with fiat currency through a Stripe integration on Helix.

All uploads to the permaweb via Helix is done with Turbo credits. Support for uploads with $AR are under development.

### Universal Data License (UDL)
#### Universal Data License (UDL)

The Universal Data License defines the terms and conditions for using media assets on the permaweb. The UDL establishes a framework for licensing digital media such as images, videos, audio, graphics and more.

Expand All @@ -30,10 +32,10 @@ You can read the full UDL [here](https://orgsxgbx4x37hfuoidzzzuixdwsi57e2eetei2e

![UDL](https://arweave.net/TDH835b0UCD0B8h8CRqPalmVCw2J_9Fp_s0UNOsa8pY)

### Universal Content Marketplace (UCM)
#### Universal Content Marketplace (UCM)

The Universal Content Marketplace (UCM) is a revolutionary protocol built on the permaweb, specifically designed to enable trustless exchange of atomic assets. It empowers creators and users alike to interact, trade, and transact with any form of digital content, from images and music to videos, papers, components, and even applications.

You can learn more about UCM's latest migration onto AO here. [here](#).
You can learn more about UCM's latest migration onto AO here. [here](https://bazar.arweave.dev/#/learn/key-concepts/bazar-on-ao).

Explore [BazAR](https://bazar.arweave.dev/#/), the first digital content marketplace built on the UCM protocol.
2 changes: 1 addition & 1 deletion src/views/Docs/DocsDetail/MD/creating-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Creating atomic assets may seem daunting at first, but once you understand a few

#### 1. Set up your permaweb profile

Just like on web2 social media, you wouldn’t want to share content from an incomplete profile. The same applies to the permaweb. When you create your permaweb profile, you can set your name, @username, bio, profile picture, and banner image. Learn more about how to create a permaweb profile [here](#).
Just like on web2 social media, you wouldn’t want to share content from an incomplete profile. The same applies to the permaweb. When you create your permaweb profile, you can set your name, @username, bio, profile picture, and banner image. Learn more about how to create a permaweb profile [here](https://bazar.arweave.dev/#/learn/permaweb-profile).

#### 2. Decide if you are creating a collection or single uploads

Expand Down
8 changes: 4 additions & 4 deletions src/views/Docs/DocsDetail/MD/how-to-use-helix.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
## How to use Helix
### How to use Helix

Helix is an easy to use tool that allows creators to upload atomic assets and create tradeable collections for your existing atomic assets. Here are the steps for how to get started uploading to the permaweb with Helix.

### Connect your permaweb profile
#### Connect your permaweb profile

When entering Helix you will be asked to connect with your Arweave wallet. You will need a permaweb profile to be able to upload through Helix. To make a permaweb profile, you must connect your Arweave wallet on [BazAR](https://bazar.arweave.dev/#/) and follow the profile creation steps.

You can create an Arweave wallet with [Arconnect](https://www.arconnect.io/) or [Othent](https://othent.io/).

### Home tab
#### Home tab

Once your profile is connected, you will see your account at the top, existing assets under the heading **Assets**, and your atomic asset collections under the heading **Collections**.

There is also a button to see your profile in [BazAR](https://bazar.arweave.dev/#/).

### Upload tab
#### Upload tab

On the **Upload** tab you will now be able to upload atomic assets, enter metadata, and create atomic asset collections.

Expand Down
2 changes: 1 addition & 1 deletion src/views/Docs/DocsDetail/MD/introduction.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to Helix
## Welcome to Helix

Helix is your introduction to uploading atomic assets to Arweave’s permaweb. Learn how to upload digital content to the permaweb and attach license rights with the Universal Data License (UDL).

Expand Down
4 changes: 2 additions & 2 deletions src/views/Docs/DocsDetail/MD/listing-assets.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Listing atomic assets on the UCM
### Listing atomic assets on the UCM

From Helix you can list your atomic asset collections on the Universal Content Marketplace (UCM).

All collections are listed in the native currency of the permaweb, $U.

**Please note that only collections can be listed directly from Helix. Single assets must be listed from BazAR.**

### Listing collections
#### Listing collections

- From the Helix homepage click the three dots under the **Actions** tab for the collection you would like to list.
- Select **Create listings**
Expand Down
4 changes: 2 additions & 2 deletions src/views/Docs/DocsDetail/MD/upload-assets.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Upload single atomic assets
### Upload single atomic assets

- Click **Select files to upload** and select the assets that you would like to upload.
- Under **Actions** you can select **Edit title** and **Edit description** for each asset to be uploaded.
Under the list of assets, the upload cost in Turbo Credits will be displayed.

### Asset details
#### Asset details

**Fractional vs single asset ownership**

Expand Down
2 changes: 1 addition & 1 deletion src/views/Docs/DocsDetail/MD/upload-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Upload an atomic asset collection
### Upload an atomic asset collection

Create an atomic asset collection from either existing atomic assets or uploading new atomic assets.

Expand Down
2 changes: 1 addition & 1 deletion src/views/Docs/DocsDetail/MD/why-create-atomic-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Creating on the permaweb opens the doors to instant sharing and engagement acros

Creating on the permaweb provides an opportunity to capture value from your creative endeavors. With the economic freedom offered by atomic assets, creators can monetize their work directly, bypassing traditional intermediaries and unlocking new revenue streams.

Creators can also set the terms for how their content can be used with the Universal Data License (UDL). Creators can upload atomic assets with UDL tags in the metadata, indicating how the media is licensed. This programmable data license gives creators full control over how their atomic assets are accessed and used. Learn more about UDL [here](#).
Creators can also set the terms for how their content can be used with the Universal Data License (UDL). Creators can upload atomic assets with UDL tags in the metadata, indicating how the media is licensed. This programmable data license gives creators full control over how their atomic assets are accessed and used.

#### Conclusion

Expand Down

0 comments on commit b3236bf

Please sign in to comment.