Indexing CIPs Repo for Core Waiting for Implementation proposals

[Ryun1]

Motivation

• Navigating CIPs is difficult
• It is not possible to search for proposals via any metric other than title / number
• This makes it difficult to find CIPs without remembering the title / number
• With the creation of the a community maintained backlog incoming,
  • being able to navigate for proposals related to core technologies (Ledger, Plutus, etc.) AND are just waiting for implementation, will be a very useful feature

Solution - How can we improve this?

• Although using tools such as https://cips.cardano.org/ provide a good solution, keeping everything inside the repository would be ideal.
• Furthermore, maintaining a dedicated list of proposals Waiting for Implementation would give this proposals more attention, raising the likelihood of inclusion within a Cardano backlog

Maybe we maintain a Waiting for core implementation list somewhere?

What are other's thoughts?

[rphair]

How about storing community-oriented metadata in git notes: https://git-scm.com/docs/git-notes ?

Example of usage here: https://stackoverflow.com/questions/5959622/how-to-tag-a-single-file-in-git/5960171#5960171)

I'm new with notes but it seems they apply to commit hashes: so I guess a GitHub CI upon PR merge would loop backwards from the latest hash to find the most recent "implementation status" attached to the README.md file.

This note could therefore be done by anyone with write permission to the branch... so editors could add them in ordinary cases — and while we couldn't for organisational repositories, those organisations would likely be interested in keeping the community posted about contingencies for their implementations, and so would enthusiastically provide those notes themselves (?).

If necessary these "notes" could also be in a standard YAML format if a complex scheme of metadata were required, and then a warning could be issued a la #837 if it failed a validation check. The output of that validating script of course would then also produce the index of "implementation status" as a file in the repository.

I'm just investigating this now so don't know if notes not showing for any of our files in the UI is because they don't have any notes yet or because notes aren't included in GitHub UI. I only know they were really unfriendly about including them in GitHub Desktop: desktop/desktop#14755 (comment)

cc @lehins @WhatisRT @zliu41 @colll78 @klntsky @MicroProofs

[rphair]

cross-referencing this review point to ensure we don't proceed on this issue without either adopting or dismissing (I prefer the latter, for portability's sake) a consideration of CIP & CPS metadata field order (cc @Ryun1): #925 (comment)