CIP-0001 | Annual overhaul and process update

[rphair]

This has all the CIP-0001 pending updates I've collected, resulting from many review threads since the beginning of the year. Most of these points have either been explicitly or tacitly agreed upon already but of course the changes need vigorous review: especially change to Enlistment as per #898.

(updated CIP-0001)

---

changed document title to CIP Process

• To make consistent with README table
• This title makes more sense as title on derived web sites, especially Developer Portal (README titles out of sync with document titles #900 (comment))

set myself as co-author (last on list), based on commit history representing nearly 2 years of maintenance (about half the time CIP-0001 has been followed)

• These are structural changes and/or rewrites, mostly to capture changes to the CIP process emergent from meetings, online review, and discussion of related issues... not including formatting fixes & mechanical updates (e.g. the recently changed list of editors):
• CIP-0001 | Emphasise request to link PR OP to readable CIP #827
• CIP-1694 | Move Acknowledgements into optional section #763
• CIP-9999 | Add mandatory Copyright + related cleanup #762
• CIP-0001 | Structure and template revisions #730
• CIP-0001 | Titles for CIPs with common purpose #594
• CIP-0001 | Allow ISO date if translation source uncommitted #585
• CIP-0001 | Section headers, Path to active, PR submission #450
• CIP-0001 | Fix status anchors, add Categories link #411

suggest label items for lists in YAML header

• as tentatively agreed in (CPS-0016? | Cardano URIs #841 (comment))

update link to #Statuses (invalid on derived sites: cardano-foundation/developer-portal#1335 (comment))

changed Discord invitation link (in references footer) to the same one on the CIP Wiki front page (to try to stop these links from proliferating)

• also made same change on top level README

added references to the CIP Wiki when appropriate

• initially: in Motivation, added link to Wiki & definition of its scope vs. the scope of CIP-0001 itself
• links for key sections, when CIP-0001 also talks about them:
  • beginning of Editors section, since it's a more exhaustive & current list of editors' goals and requirements
  • note at end of "Authors seek feedback" subsection (referring also review checklist)
• NOT covering the relatively new GitHub state tagging in CIP-0001 since
  • characteristics like Last Check, and state flow in general, were never in CIP-0001 after being removed in the last overhaul;
  • it's a "human element" of the process meant to deal with CIP workflow rather than the CIP itself.

under Versioning

• added link how to see commit history in GitHub UI (since we are recommending this as an alternative to the customary Changelog)
• clarified some difficult language indicating when & how a Versioning subsection can be applied to subsections of the specification (CIP-0001 | Structure and template revisions #730 (comment)) (cc @michaelpj)

don't include implementation code for the CIP in the CIP directory itself

• (CIP-0102 | Reference Implementation #848 (comment)) (cc @SamDelaney)
• (CIP-???? | Ouroboros Peras - Faster Settlement #872 (review)) (cc @bwbush)

added new categories, in same "enlisted" section as Plutus and Ledger

• Consensus (CIP-???? | Ouroboros Peras - Faster Settlement #872 (comment)) cc @dnadales
• Network (CIP-0137? | Decentralized Message Queue #876 (comment)) cc @coot @jpraynaud @abailly @ch1bo
• Partitioned these categories (with Catalyst, which was never enlisted with its own CIP) in their own table away from the "officially" enlisted ones.

rewritten "enlistment" section (#898 (comment)) (cc @zliu41 @lehins @WhatisRT)

• following @Ryun1's suggestion about keeping the notion of enlistment mainly intact, without eradicating it altogether (Project Enlisting - Rethinking Post-Chang #898 (comment))
• That whole section is rewritten but preserving the original language whenever possible: though generally "decentralising" it.  Mainly this eliminates the notion that there is a "maintainer" of any enlisted category.
• I still think the idea of the "enlistment badge" might be useful in "decentralised" enlistment... and probably even more so... so I've left that in.

created section & added Emeritus editors (#901 (comment)) (cc @crptmppt @SebastienGllmt @KtorZ @dcoutts)

• following EIP-1 here
• for now have added in same order as appearing as authors in the CIP-0001 header (as opposed to oldest/newest activity OR began/departed OR somehow in order of significance)

CIP-9999 updates:

• delete its unwanted H1 - an eyesore, especially on derived sites
• update Implementation Plan item: since the last remaining unticked item never happened & likely never will (though the CPS process has been validated by community usage instead)

Top-level README updates:

• added Wiki link in header, with invitation to use as pretext for community engagement
• Communication Channels = out of date & needed to be rewritten (no more YouTube or meeting transcripts; and plenty of activity happens on GitHub without waiting for the biweekly meetings... which we

fixed miscellaneous spelling, white space, formatting and grammar.

changes decided NOT to make:

• what kind of language to avoid in CIPs (CIP-0119? | Governance Metadata - DReps #788 (comment)): since the crucial question over "point of view" was already addressed in the Wiki here and other breaches of writing style are left to the editors to determine (since mostly these are matters of common sense + imitating other kinds of standards documents)

[Ryun1]

Awesome! as always Robert
we are lucky to have you

[Crypto2099]

Looks like most of the grammatical issues have been resolved and all of these changes are aligned with the evolving standards that the Editors have addressed throughout the 2024 cycle. LGTM

[rphair]

OK, I'll mark as Last Check & we can merge before meeting if @perturbing has no objections.

[perturbing]

LGTM :)