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

Add custom README for published packages #250

Open
lightwalker-eth opened this issue Feb 14, 2025 · 0 comments
Open

Add custom README for published packages #250

lightwalker-eth opened this issue Feb 14, 2025 · 0 comments
Labels
devops DevOps related documentation Improvements or additions to documentation
Milestone

Comments

@lightwalker-eth
Copy link
Member

Background

A list of the images we're publishing to GitHub appear on the ENSNode repo homepage:

Image

If we click on any of these, you'll see a README file is displayed.

Image

Goal

Opening the details of any of the images we publish to GitHub should provide a simple readme file that's specifically tailored for the image.

Suggest keeping these tailored README files as simple as possible for right now. We should give a simple summary of the image and then link to other README files if someone wants more info.

Assumed Approach

I assume there's a way where we add some new .md files (not called README) into our repo and that we then update our Dockerfiles so that they copy / rename these files as needed to get them to appear as the README.md file on these published packages.

@lightwalker-eth lightwalker-eth added devops DevOps related documentation Improvements or additions to documentation labels Feb 14, 2025
@lightwalker-eth lightwalker-eth added this to the v1 milestone Feb 14, 2025
@lightwalker-eth lightwalker-eth moved this to Todo in ENSNode Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops DevOps related documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant