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

Readme page on the website, better than moving directly to the Repo #410

Closed
Mahmoudgalalz opened this issue Mar 23, 2024 · 6 comments
Closed

Comments

@Mahmoudgalalz
Copy link

I would like to add a small feature, which is remotely fetch the Readme file of each proposal to the website itself

@ljharb
Copy link
Member

ljharb commented Mar 23, 2024

That seems like a lot of work to keep in sync. Why is that better than moving to the repo, where you're closer to filing an issue if needed?

@Mahmoudgalalz
Copy link
Author

I guess nope, I can easily do it, by just fetching the readme data into the page for each proposal since each proposal has a README by default

https://raw.githubusercontent.com/tc39/proposal-regex-escaping/main/README.md

for example fetch this data, adding a markdown transformer to HTML, and it can be live

@ljharb
Copy link
Member

ljharb commented Mar 23, 2024

Right, but what's the value/benefit?

@Mahmoudgalalz
Copy link
Author

This will support building the RSS, and its more robust we can have better features to spotlight and filter by stages and so on. See no need from it currently but I think it will has features coming later

@ljharb
Copy link
Member

ljharb commented Mar 23, 2024

As you pointed out in #409, https://github.com/tc39/dataset already potentially covers that - we wouldn't want to use readme text as a data source.

I still don't see the benefit of duplicating the source of truth - sending someone to the repo seems strictly better to me than a webpage.

@Mahmoudgalalz
Copy link
Author

Got your point, we can close it now 🙏

@ljharb ljharb closed this as completed Mar 23, 2024
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

No branches or pull requests

2 participants