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

Create /final/ permalinks for final CAIPs #269

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Conversation

bumblefudge
Copy link
Collaborator

@bumblefudge bumblefudge commented Mar 12, 2024

I created this PR to make an extra /final/ path freezing a second copy (at a second path) of each CAIP at the time it goes final.

While I was in here, I updated what little is said about the "status" field and its values in CAIP-1, and updated contributing.md to be more explicit about all this for contributors. @ligi might want to check the CAIP-1 edits!

As for next steps, I keep wondering what this means for errata or post-final edits. I think the best solution would probably be to display links back and forth between the /final/ version and the "post-final" version that lives on in /CAIPs/ which would be the equivalent of a W3C "Editor's Draft" (a less-binding version with errata applied or displayed as a differential in-line, IETF style). If the editorial WG agrees, we can open a separate issue for that tweak.

Similarly, I wonder if having an ipfs://{cid} version of each final might also be good, just in case. Also worth its own issue if that's an idea worth playing with.

@bumblefudge bumblefudge marked this pull request as draft March 12, 2024 05:28
@bumblefudge
Copy link
Collaborator Author

For context see https://github.com/ethcatherders/EIPIP issue 320

@bumblefudge bumblefudge marked this pull request as ready for review April 16, 2024 00:20
@bumblefudge bumblefudge changed the title WIP - create extra /final/ permalinks for final CAIPs Create /final/ permalinks for final CAIPs Apr 16, 2024
@obstropolos
Copy link
Contributor

@ligi - whenever you have some time can you take a look here / quick review?

@bumblefudge
Copy link
Collaborator Author

Since EIP link policy is actually just pointing to commit-specific versions of files in github view, and not jekyll, this is no longer urgent so I'm gonna switch it to Draft. I think I would rather replace Jekyll with a more elegant static site generator anyways (R.I.P. 11ty) down the road, which would not require the gymnastics of creating a final file in a separate directory... would rather a version-aware generator or something more like IETF Datatracker that presents rendered and raw versions of the docs. Leaving this in the backlog for now

@bumblefudge bumblefudge marked this pull request as draft June 13, 2024 14:59
@bumblefudge bumblefudge marked this pull request as draft June 13, 2024 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants