Open rphair opened 2 months ago
Any decisions made about whether to move forward with this will have no negative impact on my work around the CIPs. So I'm okay with any outcome. 😃👍
I don't think the fix needs to be rushed. Personally, I use the CIP numbers more than the titles when navigating/referencing, and the titles seem "close enough". I didn't even notice some of the titles were out of sync :sweat_smile:
This is one CIP that should be retitled ASAP as in the repo README:
< CIP-0001: Cardano Improvement Proposals
---
> CIP-0001: CIP process
Until then, the Cardano Improvement Proposals (CIPs) section of the Dev Portal will have a first heading of (1) Cardano Improvement Proposals... it would be more meaningful for readers (as it is on the CIP repo README) to have the first heading be CIP Process. See: https://developers.cardano.org/docs/governance/cardano-improvement-proposals/CIP-0001
Result of investigating https://github.com/cardano-foundation/CIPs/pull/854#discussion_r1741144968.
I thought it would be an easy check & fix for the small number of CIP titles that might be disparate with the titles in the repository front page table.
But even when ignoring case comparisons (a substantial source of difference & maybe even a problem for some kinds of indexing / parsing) there are quite a few that apparently drifted in the review process:
This above is a complete list of differences at this time but before rushing ahead to change them I wanted to get the feeling from editors & community how much of an issue they think this is. In many of these cases I also wouldn't be sure whether the README title or the document title would be better.
Likely before the end of the year @Ryun1 and/or I will be producing some automation that will build this table from the source documents anyway... which would confirm that the document titles are canonical by default.
My inclination is therefore to declare the differences above "cosmetic" but still keep this issue open until some GitHub automation produces a character-perfect table.
To confirm that's OK (or not) I wanted to sample opinions from people who work with CIPs (including rendering them on other web sites) whether they think these differences should be resolved right away: @Crypto2099 @KtorZ @katomm @fill-the-fill @WhatisRT @lehins @zliu41 @perturbing @fallen-icarus @Hornan7