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

[chore 🧹] Update README with more detailed information #3643

Closed
Tracked by #4620
niccoloraspa opened this issue Dec 6, 2022 · 5 comments
Closed
Tracked by #4620

[chore 🧹] Update README with more detailed information #3643

niccoloraspa opened this issue Dec 6, 2022 · 5 comments
Labels
C:docs Improvements or additions to documentation Help wanted T:ice-box T:ice-box-repo

Comments

@niccoloraspa
Copy link
Member

Background

The current README does not provide enough information about the project and its goals, as well as clear instructions for getting started and contributing.

It would be useful to update the README with more detailed information and instructions to make it easier for potential users and contributors to understand and engage with the project.

Suggested Design

We can build on top of what ChatGPT proposed https://hackmd.io/@sq7nPjAATDS1_frTus12Wg/H1IQUchws, fixing the mistakes and adding the missing sections (joining mainnet/testnet, links to docs).

Acceptance Criteria

README.md updated

@niccoloraspa
Copy link
Member Author

@daniel-farina do you have any suggestions?

@niccoloraspa niccoloraspa added the C:docs Improvements or additions to documentation label Dec 6, 2022
@ValarDragon
Copy link
Member

want to submit a PR with the initial improvement, to get the ball rolling?

@faddat
Copy link
Member

faddat commented Dec 12, 2022

@niccoloraspa hey, could you share the prompts you used for this?

Also, I'm super happy to kick off the PR. The linked doc was written by chatgpt?

amaze.

@niccoloraspa
Copy link
Member Author

Sure! I just copied the current one as an explanation and just asked if ChatGPT could write a GitHub Readme. The AI gods did the rest

@p0mvn
Copy link
Member

p0mvn commented Apr 1, 2024

This issue is outdated. We can revisit the improvements we want in a new issue. Closing for now

@p0mvn p0mvn closed this as completed Apr 1, 2024
@github-project-automation github-project-automation bot moved this from Todo 🕒 to Done ✅ in Osmosis Chain Development Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:docs Improvements or additions to documentation Help wanted T:ice-box T:ice-box-repo
Projects
Archived in project
Development

No branches or pull requests

5 participants