Skip to content

Commit

Permalink
feat: add ToC
Browse files Browse the repository at this point in the history
  • Loading branch information
Alan Shaw committed Sep 13, 2023
1 parent e40a9ef commit 59831de
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion w3-filecoin.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,38 @@ This spec describes a [UCAN] protocol allowing an implementer to receive an aggr

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119](https://datatracker.ietf.org/doc/html/rfc2119).

# Table of Contents

* [Terminology](#terminology)

Check failure on line 25 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-filecoin.md:25:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
* [Roles](#roles)

Check failure on line 26 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-filecoin.md:26:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 26 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list indentation [Expected: 2; Actual: 4]

w3-filecoin.md:26:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
* [Storefront](#storefront)

Check failure on line 27 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-filecoin.md:27:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 27 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list indentation [Expected: 4; Actual: 8]

w3-filecoin.md:27:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 8]
* [Aggregator](#aggregator)

Check failure on line 28 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-filecoin.md:28:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 28 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list indentation [Expected: 4; Actual: 8]

w3-filecoin.md:28:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 8]
* [Dealer](#dealer)

Check failure on line 29 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-filecoin.md:29:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 29 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list indentation [Expected: 4; Actual: 8]

w3-filecoin.md:29:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 8]
* [Deal Tracker](#deal-tracker)

Check failure on line 30 in w3-filecoin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-filecoin.md:30:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
* [Protocol](#protocol)
* [Overview](#overview)
* [Authorization](#authorization)
* [Capabilities](#capabilities)
* [Storefront Capabilities](#storefront-capabilities)
* [`filecoin/queue`](#filecoinqueue)
* [`filecoin/add`](#filecoinadd)
* [Aggregator Capabilities](#aggregator-capabilities)
* [`aggregate/queue`](#aggregatequeue)
* [`aggregate/add`](#aggregateadd)
* [Dealer Capabilities](#storefront-capabilities)
* [`deal/queue`](#dealqueue)
* [`deal/add`](#dealadd)
* [Deal Tracker Capabilities](#deal-tracker-capabilities)
* [`dealtracker/info`](#dealtrackerinfo)
* [Schema](#schema)
* [`filecoin/queue` schema](#filecoinqueue-schema)
* [`filecoin/add` schema](#filecoinadd-schema)
* [`aggregate/queue` schema](#aggregatequeue-schema)
* [`aggregate/add` schema](#aggregateadd-schema)
* [`deal/queue` schema](#dealqueue-schema)
* [`deal/add` schema](#dealadd-schema)
* [`dealtracker/info` schema](#dealtrackerinfo-schema)

# Terminology

## Roles
Expand Down Expand Up @@ -161,7 +193,7 @@ sequenceDiagram

This section describes the capabilities that form the w3 aggregation protocol, along with the details relevant for invoking capabilities with a service provider.

In this document, we will be exposing capabilities implemented by Storefront `web3.storage`, Aggregator `aggregator.web3.storage` and Dealer `dealer.web3.storage`.
In this document, we will be exposing capabilities implemented by Storefront `web3.storage`, Aggregator `aggregator.web3.storage`, Dealer `dealer.web3.storage` and Deal Tracker `dealtracker.web3.storage`.

### Storefront Capabilities

Expand Down

0 comments on commit 59831de

Please sign in to comment.