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
Updates README.md to be more compelling #24
Conversation
…es to the wiki and allow PRs in that area
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Megan Wiemer.
|
Kudos, SonarCloud Quality Gate passed! |
…ting-Started.md - RAG
…or and Improvement section - RAG
EOD: Brought in Wiki files to source so that we can codify the changes. We also improved our tone and voice to be better on brand (more to go). |
…a tutorial and starting pivot of Getting Started into a minimum guide to getting started with more details than the quick start. - MOB
…ily internal members - MOB
…hed out in text - Mob
… in the Getting-Started - RAG
…ng-Started.md - RAG
EOD: Decided that the original direction of Getting-Started was more suited as a Tutorial and a more slimmed down, succinct version should be used instead. |
Just dropping a note here to run Jazzy again so that it has the updated README for its documentation. |
…d marked remaining section of the page that needs more love - RAG BL
… do not interrupt scrolling through the high level docs - RAG BL
…is_Library.md and fixed typo. - RAG
I was uncertain at the time myself. I don't have any issues with it per se but this feels like documentation that would be easily overlooked if we changed the name/link |
… working on SwiftPM - MW RAG
…ftPM and have better wording for Core library - TT RAG
…ion on Swift - TT RAG
…ould be included on Quickstart. Also fixed CocoaPods capitalization - TT RAG
Someone please create a Change Request to generate Jazzy documentation so we don't forget. I don't want to do it now because it obscures the important changes we made. EOD: We rechecked our tone compared to what WWT expects in our branding, and revised Installation to match that voice. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The commented out gif to be added either make a card or finish it in this. The rest to be fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do the thing it says.
Co-authored-by: Wiemer <10991616+wiemerm@users.noreply.github.com>
Kudos, SonarCloud Quality Gate passed! |
Linked Issue:
Checklist:
If Applicable:
If Public API Has Changed: