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

docs: improve "Quick Start" documentation in top-level and sir example READMEs #561

Merged

Conversation

LSarribouette
Copy link
Contributor

@LSarribouette LSarribouette commented Nov 19, 2024

Fixes #564

Improves the documentation related to discussion #559.

Edited by Chris to retroactively reference a new issue describing the changes.

@LSarribouette
Copy link
Contributor Author

Hi! It is my first fork and pull request on someone else's repo. Please let me know if I should do anything differently :)

@chrispcampbell
Copy link
Contributor

Hi @LSarribouette, thanks for taking the time to contribute these edits!

Your discussion thread prompted me to finally address #335 today (which I will merge and release tomorrow). That will render your proposed text somewhat inaccurate, so I will need to change it a bit before merge, and I will work on that tomorrow. I will probably move part of the text to a "troubleshooting" section in the wiki.

In any case, I appreciate your edits because they make it more obvious where I can improve the docs.

It is my first fork and pull request on someone else's repo. Please let me know if I should do anything differently :)

You did it correctly, and you even included a well-formatted pull request title, so all good from my perspective :)

@LSarribouette
Copy link
Contributor Author

Awesome, thanks for your work!

@chrispcampbell chrispcampbell changed the title docs: improve README on "Quick Start" documentation when pre-existing config folder docs: improve "Quick Start" documentation in top-level and sir example READMEs Nov 21, 2024
@chrispcampbell
Copy link
Contributor

I updated your PR per my previous comments, so the text is different than the proposed but the areas touched are the same, and we now point to the wiki page with a new "Troubleshooting" section (that page will be good to flesh out as time goes on). Thanks again for pointing me in the right direction!

@chrispcampbell chrispcampbell merged commit b20655a into climateinteractive:main Nov 21, 2024
3 checks passed
@LSarribouette LSarribouette deleted the lauranne/readme-update branch November 22, 2024 12:40
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

Successfully merging this pull request may close these issues.

Improve "Quick Start" documentation in top-level README and sir example README
2 participants