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

Replace requires with a bibliography #6509

Closed
Pandapip1 opened this issue Feb 16, 2023 · 10 comments
Closed

Replace requires with a bibliography #6509

Pandapip1 opened this issue Feb 16, 2023 · 10 comments
Labels
enhancement r-eips Relates to the formatting or another aspect of EIPs w-stale Waiting on activity

Comments

@Pandapip1
Copy link
Member

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.

@Pandapip1 Pandapip1 added enhancement r-eips Relates to the formatting or another aspect of EIPs labels Feb 16, 2023
@Pandapip1
Copy link
Member Author

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

@SamWilsn
Copy link
Contributor

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?

@SamWilsn
Copy link
Contributor

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.

@Pandapip1
Copy link
Member Author

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.

@Pandapip1
Copy link
Member Author

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

@SamWilsn
Copy link
Contributor

SamWilsn commented Feb 16, 2023

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.

@github-actions
Copy link

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

@github-actions github-actions bot added the w-stale Waiting on activity label Jul 31, 2023
@Pandapip1
Copy link
Member Author

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.

@Pandapip1 Pandapip1 linked a pull request Aug 11, 2023 that will close this issue
@github-actions github-actions bot removed the w-stale Waiting on activity label Aug 12, 2023
@github-actions
Copy link

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

@github-actions github-actions bot added the w-stale Waiting on activity label Aug 20, 2023
@github-actions
Copy link

github-actions bot commented Oct 8, 2023

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

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement r-eips Relates to the formatting or another aspect of EIPs w-stale Waiting on activity
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@Pandapip1 @SamWilsn and others