Skip to content

Commit

Permalink
CIP-1: update Preamble section for header table (#191)
Browse files Browse the repository at this point in the history
* docs: update section for header table

Clarifies markdown table

* Apply suggestions from code review

* Apply suggestions from code review

* Update cips/cip-1.md

Co-authored-by: Rootul P <[email protected]>

---------

Co-authored-by: Rootul P <[email protected]>
  • Loading branch information
jcstein and rootulp authored Jul 30, 2024
1 parent 5fdbeae commit 089b374
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions cips/cip-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,11 +312,10 @@ format. There is a [CIP template](./cip-template.md) to follow.

## CIP Header Preamble

Each CIP must begin with an RFC 822 style header preamble, preceded
and followed by three hyphens (---). This header is also termed
“front matter” by Jekyll. The headers must appear in the following order.
In order to display on the CIP site, the frontmatter must be
formatted in a markdown table.
Each CIP must begin with an RFC 822 style header preamble in a
markdown table.
In order to display on the CIP site, the frontmatter must be formatted
in a markdown table. The headers must appear in the following order:

* `cip`: CIP number (this is determined by the CIP editor)
* `title`: The CIP title is a few words, not a complete sentence
Expand Down

0 comments on commit 089b374

Please sign in to comment.