ethereum/EIPs

Replace requires with a bibliography

Pandapip1 opened this issue · 10 comments

Proposed Change

I suggest that we replace the requires preamble item with a bibliography preamble item that uses a YAML version of CSL-json, to allow for #5733.

(FYI - I'm trying to make the EIPs website index-able by Google Scholar)

Having a simple field of EIP numbers makes it significantly easier for the common use case: referencing other EIPs. Making authors learn the whole CSL-JSON notation when what we have today works well is going to be a hard sell.

That said, I wholeheartedly support a more standard bibliography/references section in the generated HTML.

Is there some way we can combine the requires header with the CSL-JSON blocks, and automatically generate the proper citations in the rendered output?

Oh, and I like the simple key: value format we've got going on in the preamble today. I think most people understand it. I know it's technically a full YAML document, but... maybe it shouldn't be.

We can always make our own extension. For example, there's a shorthand for citing wikipedia articles; it shouldn't be too hard to copy that, use a different prefix, and modify the other stuff.

@SamWilsn would you be okay if I made a prototype?

You don't need my permission 🤣

I'd probably recommend starting with an example of what such an EIP would look like before diving into the implementation, so we can discuss that.

There has been no activity on this issue for 1 week. It will be closed after 3 months of inactivity.

Completely forgot about this. Don't know why the bot didn't trigger until 2 weeks ago and why I didn't get notified until now.

There has been no activity on this issue for 1 week. It will be closed after 3 months of inactivity.

This issue was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback.