Commit 088ed7a3 authored by Sarah Fowler's avatar Sarah Fowler

Update links to /TZIP-\d.md files

parent df88ea90
Pipeline #100695501 passed with stage
---
tzip: 1
title: TZIP-1 (TZIP Purpose and Guidelines) FAQ
title: TZIP-0001 (TZIP Purpose and Guidelines) FAQ
status: WIP
type: Meta
author: John Burnham, Jacob Arluck
......@@ -10,7 +10,7 @@ created: 2019-04-12
## What is a TZIP?
Response copied from [TZIP-1](/Proposals/TZIP-0001/TZIP-0001.md#what-is-a-tzip):
Response copied from [TZIP-0001](/Proposals/TZIP-0001/TZIP-0001.md#what-is-a-tzip):
An TZIP is a design document providing information to the Tezos community,
describing a feature for Tezos or its processes or environment, and supporting
......
......@@ -72,13 +72,13 @@ Maintainers of Tezos tools and libraries can list the TZIPs that they have
implemented, which can give the community a convenient way to know the current
status of a given project.
There are many types of TZIP defined in [TZIP-2], where the TZIP Editors
There are many types of TZIP defined in [TZIP-0002], where the TZIP Editors
maintain an up-to-date list. Unlike some other standardization schemas, instead
of purely numeric serial numbers, TZIPs use "TZIP indices", a system similar to
the Library of Congress Classification that mixes alphabetic topic prefixes
("A", "P", etc.) with serial numbers which may be extended with a `.` character
(e.g. `FA1.2` is an extension of `FA1`) This index namespace is also defined
in [TZIP-2].
in [TZIP-0002].
It is highly recommended that a single TZIP contain a single key proposal or
new idea corresponding to its type. The more precise the TZIP, the more
......@@ -166,7 +166,7 @@ impartial judgement. An editor cannot review a TZIP of which they are an
advocate or an author.
Throughout this process, the editors agree to follow and enforce TZIP Code of
Conduct, described in [TZIP-3: TZIP Code of Conduct][TZIP-3]
Conduct, described in [TZIP-0003: TZIP Code of Conduct][TZIP-0003]
## TZIP Workflow
......@@ -354,7 +354,7 @@ gratuities from grateful Tezoi>
`* review-period-end:` <date review period ends>
` type:` Defined in TZIP-2:
` type:` Defined in TZIP-0002:
` created:` <date created on>
......@@ -441,7 +441,7 @@ extraordinary circumstances unilateral decision of the editors.
This document was derived heavily from Ethereum's [EIP-1] which was in turn
derived from [Bitcoin's BIP-0001] written by Amir Taaki and [Python's PEP-0001],
written by Barry Warsaw, Jeremy Hylton, and David Goodger. In many places text
was simply copied and modified. A further influence from `TZIP-1` was Martin
was simply copied and modified. A further influence from `TZIP-0001` was Martin
Pospěch's [tip-1].
None of the authors of [EIP-1], [BIP-0001], [PEP-0001] or [tip-1] text are
......@@ -466,8 +466,8 @@ Copyright and related rights waived via
[Hansard]: https://en.wikipedia.org/wiki/Hansard
[TZIP-2]: /TZIP-2.md
[TZIP-3]: /TZIP-3.md
[TZIP-0002]: /Proposals/TZIP-0002/TZIP-0002.md
[TZIP-0003]: /Proposals/TZIP-0003/TZIP-0003.md
[tip-1]: https://gitlab.com/tips2/TIPs/blob/master/TIPS/tip-1.md
[Ethereum's EIP-1]: https://github.com/ethereum/EIPs
[Bitcoin's BIP-0001]: https://github.com/bitcoin/bips
......
......@@ -154,7 +154,7 @@ TZIP-FA2
TZIP-A3.4
```
Meta-level standards (such as this one `TZIP-2`) should always have `TZIP`
Meta-level standards (such as this one `TZIP-0002`) should always have `TZIP`
prepended to their index codes.
## TZIP Index: Types
......@@ -215,9 +215,9 @@ another as much as possible and are binding on TZIP editors.
Additional types of TZIP may be proposed, and existing TZIP types may also be
deprecated by future Meta TZIPs. The TZIP Editors will maintain up-to-date list
of active TZIP types in [TZIP-2: TZIP Index][TZIP-2].
of active TZIP types in [TZIP-0002: TZIP Index][TZIP-0002].
[TZIP-1]: (/TZIP-1.md)
[TZIP-0001]: (/Proposals/TZIP-0001/TZIP-0001.md)
[issue-20]: https://github.com/ethereum/EIPs/issues/20
[issue-16]: https://github.com/ethereum/EIPs/issues/16
[pubprocess]: https://www.rfc-editor.org/pubprocess/
......
......@@ -73,7 +73,7 @@ with field annotations, and all top-level union type arguments are unannotated.
Nevertheless, it is advisable that specific implementations adhere to a
consistent tree-struct convention, examples of which can be seen in various
extensions of this standard (such as [`TZIP-A1.1`](./A1.1.md)).
extensions of this standard (such as [`TZIP-A1.1`](/Proposals/TZIP-0006/A1.1.md)).
### Example
......@@ -186,7 +186,7 @@ indentation and whitespacing rules.
This standard defines only tuples and unions of size two.
Introduced syntax sugar becomes especially useful in extensions of the
standard where this syntax is generalized
(see [`TZIP-A1.1`](./A1.1.md) for example).
(see [`TZIP-A1.1`](/Proposals/TZIP-0006/A1.1.md) for example).
# CASE macro
......
......@@ -257,7 +257,7 @@ Decoding usually involves the following:
### Extensions
Some use cases would benefit from being able to transmit more information in the payment requests. This can be done by extending the standard. The extensions should be described by a separate standard and use a field based on the name of the standard to store their data. This will help avoid collisions with other extensions.
For example, an extension described in TZIP-9 that adds an information field could store its data like this:
For example, an extension described in TZIP-0009 that adds an information field could store its data like this:
```json
[
......@@ -296,7 +296,7 @@ The payload format closely mirrors the format expected by Tezos RPC, so that it
To make the standard as simple to implement as possible, we have decided against a more abstract payload format.
### Misc. Information Field
The requests only include a subset of fields from the RPC format. To keep the standard simple, there are no extra fields such as a miscellaneous information field to describe a transaction. This could then be displayed by users' wallet, but wouldn't be sent anywhere. Extensions to the standard are possible, and a misc. information field is described by [TZIP9](https://gitlab.com/tzip/tzip/blob/master/TZIP-9.md).
The requests only include a subset of fields from the RPC format. To keep the standard simple, there are no extra fields such as a miscellaneous information field to describe a transaction. This could then be displayed by users' wallet, but wouldn't be sent anywhere. Extensions to the standard are possible, and a misc. information field is described by [TZIP-0009](/Proposals/TZIP-0009/TZIP-0009.md).
## Implementation
......
......@@ -3,15 +3,15 @@ Headers marked with "*" are optional. All other headers are required.
tzip: <TZIP index code> (this is determined by the editor)
title: <TZIP title>
author: <a list of the author's or authors' name(s) and/or username(s), or
name(s) and email(s). [More Details](/TZIP-1.md#author-header)>
name(s) and email(s). [More Details](/Proposals/TZIP-0001/TZIP-0001.md#author-header)>
advocate *: <a list of the author's or authors' name(s) and/or username(s), or
name(s) and email(s). [More Details](/TZIP-1.md#author-header)>
name(s) and email(s). [More Details](/Proposals/TZIP-0001/TZIP-0001.md#author-header)>
gratuity *: <a Tezos address controlled by an author capable of receiving
gratuities from grateful Tezoi>
discussions-to *: <a url pointing to the official discussion thread>
status: <WIP | Draft | Last Call | Final | Active | Pending | Protocol | Rejected | Superseded>
review-period-end *: <date review period ends>
type: <Defined in [TZIP-2](/TZIP-2.md#tzip-index-types)>
type: <Defined in [TZIP-0002](/Proposals/TZIP-0002/TZIP-0002.md#tzip-index-types)>
created: <date created on>
updated *: <comma separated list of dates>
requires *: <TZIP indices>
......
......@@ -3,15 +3,15 @@ Header has to be copied from the created TZIP.
tzip: <TZIP index code> (this is determined by the editor)
title: <TZIP title>
author: <a list of the author's or authors' name(s) and/or username(s), or
name(s) and email(s). [More Details](/TZIP-1.md#author-header)>
name(s) and email(s). [More Details](/Proposals/TZIP-0001/TZIP-0001.md#author-header)>
advocate *: <a list of the author's or authors' name(s) and/or username(s), or
name(s) and email(s). [More Details](/TZIP-1.md#author-header)>
name(s) and email(s). [More Details](/Proposals/TZIP-0001/TZIP-0001.md#author-header)>
gratuity *: <a Tezos address controlled by an author capable of receiving
gratuities from grateful Tezoi>
discussions-to *: <a url pointing to the official discussion thread>
status: <WIP | Draft | Last Call | Final | Active | Pending | Protocol | Rejected | Superseded>
review-period-end *: <date review period ends>
type: <Defined in [TZIP-2](/TZIP-2.md#tzip-index-types)>
type: <Defined in [TZIP-0002](/Proposals/TZIP-0002/TZIP-0002.md#tzip-index-types)>
created: <date created on>
updated *: <comma separated list of dates>
requires *: <TZIP indices>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment