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

Generate README.md files with 11ty #81

Open
LeaVerou opened this issue May 24, 2024 · 1 comment
Open

Generate README.md files with 11ty #81

LeaVerou opened this issue May 24, 2024 · 1 comment
Milestone

Comments

@LeaVerou
Copy link
Contributor

Currently we have data about backends that we have to maintain in several different places just so we could have reasonable READMEs. If we generated the READMEs we could generate them from data that is stored in one place (e.g. together with the bakend, as a sort of manifest file) or even the backends themselves, by having JS data files that import the backends and read their properties!

The downside would be that we'd need to commit build artifacts to the repo (the README files) but I think that's acceptable.

@LeaVerou LeaVerou added this to the Public launch milestone Jun 24, 2024
@LeaVerou
Copy link
Contributor Author

I was thinking the file could be as simple as meta.json containing a structure like:

{
	name: "GitHub Files", // auto-generated if not present
	description: "Write & read data and upload files to GitHub repositories. Create GitHub repositories as needed",
	can: { read: true, write: true, uploads: true, login: true }
}

Parents & children would be determined from URL structure.

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

1 participant