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

Adding Wikipedia-style "[citation needed]" when explanations are missing #488

Open
josebolos opened this issue Feb 28, 2025 · 0 comments
Open

Comments

@josebolos
Copy link
Contributor

Meta-issue about the Playbook itself, to discuss.

I think that it's fair to say that we want the stuff contained in the Frontend Playbook to be as objective as reasonably possible, and the guidelines contained based on researched facts rather than on personal preference. The Playbook has grown a lot over the years, people have come and go, and as a result it's possible that the reasoning for certain practices may have been lost.

I propose that we find a way to mark statements that may need backing up, so that people reading the Playbook know that something is incomplete. They may even consider contributing to fill in the gap!

A way to do this could be using a mechanism similar to Wikipedia's [citation needed], so for example, on the following example taken from https://github.com/springernature/frontend-playbook/blob/main/performance/browser-caching.md#css-js-and-images

Frameworks like Shunter use the filename version style which is preferred.

There's no reasoning why the filename version style is preferred, so we could include a "[citation needed]" or "[reason missing]" or "[y tho]" link to a new page explaining that something is missing, and person wanting to contribute to the Playbook may decide to help improve the text:

Frameworks like Shunter use the filename version style which is preferred.[y tho?]

Thoughts?

@josebolos josebolos changed the title Adding Wikipedia-style "citation needed" Adding Wikipedia-style "[citation needed]" when explanations are missing Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant