Skip to content

Commit 23f7cc2

Browse files
committed
chore: markdown lint
1 parent f65babb commit 23f7cc2

3 files changed

+34
-38
lines changed

IPIP/0000-template.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ submit your IPIP, please use number 0000 and an abbreviated title in the filenam
88
- Related Issues:
99
- (add links here)
1010

11-
# Summary
11+
## Summary
1212

1313
<!--One paragraph explanation of the IPIP.-->
1414
This is the suggested template for new IPIPs.
1515

16-
# Motivation
16+
## Motivation
1717

1818
AKA Problem Statement
1919

2020
Clearly explain why the existing protocol specification is inadequate
2121
to address the problem that the IPIP solves.
2222

23-
# Detailed design
23+
## Detailed design
2424

2525
AKA Solution Proposal
2626

IPIP/0001-lightweight-improvement-proposal-process.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
- Related Issues:
55
- [ipfs/specs/issues/286](https://github.com/ipfs/specs/issues/286)
66

7-
# Summary
7+
## Summary
88

99
This _InterPlanetary Improvement Proposal_ (IPIP) introduces a lightweight
1010
"request for comments/change" process for the IPFS specifications
1111
[repository][1].
1212

1313
[1]: https://github.com/ipfs/specs/
1414

15-
# Motivation
15+
## Motivation
1616

1717
Today, protocol design discussions often take place in a repository of an IPFS
1818
implementation. These conversations are unintentionally obscured from the useful input of [Specs Stewards], other
@@ -22,7 +22,7 @@ The IPFS Project needs a mechanism for proposing and evaluating specification
2222
improvements that are not tied to a specific programming language
2323
or implementation of IPFS.
2424

25-
# Detailed design
25+
## Detailed design
2626

2727
Adopt an informal IPIP process for the [ipfs/specs][1] repository, providing a
2828
minimal structure for opening, reviewing, and merging specification changes.
@@ -31,19 +31,19 @@ The purpose of IPIP documents is to **document motivation** behind the change
3131
applied to the spec. **IPIP is not to be the spec itself**.
3232

3333
To illustrate:
34-
- In order to understand how (hypothetical) WebDAV Gateway works, one would
35-
read contents of specs in `ipfs/specs/WEBDAV_GATEWAY.md`.
36-
- IPIP in `ipfs/specs/IPIP/000N-webdav-gateway.md` would only include
37-
**Motivation** and explainer why certain design decisions were made at a
38-
certain point in time. Initial `IPIP/000N-webdav-gateway.md` would explain
39-
why we added WebDAV spec in the first place.
40-
- If we realize the spec has a bug, we will evaluate the impact: adding more
41-
details, test vectors, and editorials/cosmetics can be fixed without IPIP.
42-
- Things that could cause an interop issues require a PR with fix and IPIP in
43-
`ipfs/specs/IPIP/000M-webdav-fix-for-foo.md` explaining why we make the
44-
breaking spec change, compatibility/migration considerations etc.
45-
46-
## Opening an improvement proposal (IPIP)
34+
- In order to understand how (hypothetical) WebDAV Gateway works, one would
35+
read contents of specs in `ipfs/specs/WEBDAV_GATEWAY.md`.
36+
- IPIP in `ipfs/specs/IPIP/000N-webdav-gateway.md` would only include
37+
**Motivation** and explainer why certain design decisions were made at a
38+
certain point in time. Initial `IPIP/000N-webdav-gateway.md` would explain
39+
why we added WebDAV spec in the first place.
40+
- If we realize the spec has a bug, we will evaluate the impact: adding more
41+
details, test vectors, and editorials/cosmetics can be fixed without IPIP.
42+
- Things that could cause an interop issues require a PR with fix and IPIP in
43+
`ipfs/specs/IPIP/000M-webdav-fix-for-foo.md` explaining why we make the
44+
breaking spec change, compatibility/migration considerations etc.
45+
46+
### Opening an improvement proposal (IPIP)
4747

4848
Changes to IPFS specifications can be proposed by opening a Git pull-request
4949
(PR) against the `ipfs/specs` repository.
@@ -53,7 +53,7 @@ document** based on the template in `ipfs/specs/IPIP/0000-template.md`.
5353

5454
When a new specification is added, `ipfs/specs/template.md` can be used.
5555

56-
## Reviewing IPIPs
56+
### Reviewing IPIPs
5757

5858
[Specs Stewards] will review new IPIP PRs during periodical (best-effort) triage.
5959

@@ -66,7 +66,7 @@ IPIP can be either:
6666

6767
The final decision belongs to [Specs Stewards].
6868

69-
## Merging IPIPs
69+
### Merging IPIPs
7070

7171
PR with a IPIP can be merged only after two [Specs Stewards] approve it and
7272
there are no objections from other Stewards.
@@ -77,7 +77,7 @@ IPIP author and two approving [Specs Stewards] are added to `CODEOWNERS` file
7777
to be automatically asked to review any future changes to files added or
7878
modified by the IPIP.
7979

80-
## Long-term plan
80+
### Long-term plan
8181

8282
[Specs Stewards] will adjust the process based on usage patterns.
8383

README.md

+12-16
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22

33
> This repository contains the specs for the IPFS Protocol and associated subsystems.
44
5-
# Table of Contents
6-
7-
- [IPFS Specifications](#ipfs-specifications)
8-
- [Table of Contents](#table-of-contents)
9-
- [Documentation and Community](#documentation-and-community)
10-
- [Understanding the meaning of the spec badges and their lifecycle](#understanding-the-meaning-of-the-spec-badges-and-their-lifecycle)
11-
- [Index](#index)
12-
- [Contribute](#contribute)
13-
- [InterPlanetary Improvement Process (IPIP)](#interplanetary-improvement-process-ipip)
5+
- [Documentation and Community](#documentation-and-community)
6+
- [Understanding badges](#understanding-the-meaning-of-the-spec-badges-and-their-lifecycle)
7+
- [Index](#index)
8+
- [Contribute](#contribute)
9+
- [InterPlanetary Improvement Process (IPIP)](#interplanetary-improvement-process-ipip)
1410

1511
## Documentation and Community
1612

@@ -22,12 +18,12 @@ See https://docs.ipfs.io, https://discuss.ipfs.io/ and https://docs.ipfs.io/comm
2218

2319
We use the following label system to identify the state of each spec:
2420

25-
- ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) - A work-in-progress, possibly to describe an idea before actually committing to a full draft of the spec.
26-
- ![](https://img.shields.io/badge/status-draft-yellow.svg?style=flat-square) - A draft that is ready to review. It should be implementable.
27-
- ![](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square) - A spec that has been adopted (implemented) and can be used as a reference point to learn how the system works.
28-
- ![](https://img.shields.io/badge/status-stable-brightgreen.svg?style=flat-square) - We consider this spec to close to final, it might be improved but the system it specifies should not change fundamentally.
29-
- ![](https://img.shields.io/badge/status-permanent-blue.svg?style=flat-square) - This spec will not change.
30-
- ![](https://img.shields.io/badge/status-deprecated-red.svg?style=flat-square) - This spec is no longer in use.
21+
- ![wip](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) - A work-in-progress, possibly to describe an idea before actually committing to a full draft of the spec.
22+
- ![draft](https://img.shields.io/badge/status-draft-yellow.svg?style=flat-square) - A draft that is ready to review. It should be implementable.
23+
- ![reliable](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square) - A spec that has been adopted (implemented) and can be used as a reference point to learn how the system works.
24+
- ![stable](https://img.shields.io/badge/status-stable-brightgreen.svg?style=flat-square) - We consider this spec to close to final, it might be improved but the system it specifies should not change fundamentally.
25+
- ![permanent](https://img.shields.io/badge/status-permanent-blue.svg?style=flat-square) - This spec will not change.
26+
- ![deprecated](https://img.shields.io/badge/status-deprecated-red.svg?style=flat-square) - This spec is no longer in use.
3127

3228
Nothing in this spec repository is `permanent` or even `stable` yet. Most of the subsystems are still a `draft` or in `reliable` state.
3329

@@ -77,7 +73,7 @@ The specs contained in this and related repositories are:
7773

7874
## Contribute
7975

80-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
76+
[![contribute](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
8177

8278
Suggestions, contributions, criticisms are welcome. Though please make sure to familiarize yourself deeply with IPFS, the models it adopts, and the principles it follows.
8379
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

0 commit comments

Comments
 (0)