Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal to remove CIPs from the developer portal #1362

Open
katomm opened this issue Nov 25, 2024 · 1 comment
Open

Proposal to remove CIPs from the developer portal #1362

katomm opened this issue Nov 25, 2024 · 1 comment
Assignees
Labels
help wanted Extra attention is needed

Comments

@katomm
Copy link
Member

katomm commented Nov 25, 2024

Hello,

I want to revisit what I wrote in #1335 and expand on it. When we launched https://developers.cardano.org, https://cips.cardano.org was not in an optimal state. Browsing or searching for CIPs was challenging, so we made a considerable effort to integrate CIPs into the developer portal from the start.

Currently, the developer portal is (somewhat) stuck on the 2.xx version of Docusaurus because of this integration. The list of compromises to maintain this setup continues to grow, and I believe we’ve reached a point where it’s worth questioning whether to remove CIPs from the portal altogether.

That said, https://cips.cardano.org has significantly improved over the past few years. One alternative could be indexing cips.cardano.org with the Developer Portal’s search functionality. This way, users could search for CIP content through the Developer Portal and be redirected directly to cips.cardano.org. While this would require substantial initial work, it would greatly reduce maintenance efforts in the long run. (However, this is outside the scope of this proposal.)

Some relevant references (but the list of issues is huge):
#1157
#1335
#1135
#1122
#1106

@katomm katomm added the help wanted Extra attention is needed label Nov 25, 2024
@katomm katomm self-assigned this Nov 25, 2024
@rdlrt
Copy link
Collaborator

rdlrt commented Nov 26, 2024

Have always felt avoiding duplication for documntation of same content is best, especially with the said improvements at source site. This would be a welcome change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants