Skip to content

Conversation

@mnapoli
Copy link
Contributor

@mnapoli mnapoli commented Jul 8, 2021

I went over the README to see if there was anything that could be improved.

This PR is very light, but I mostly tried to make documentation links more obvious (since this template includes Lift, which is pretty new to both new and experienced Framework users).

Slight changes also to remove a few words: for non-native English speakers, simpler sentences are always a bit easier to read.

That's a suggestion anyway, we can discuss this in the meeting later today!

@mnapoli mnapoli requested a review from pgrzesik July 8, 2021 13:10
Copy link
Contributor

@pgrzesik pgrzesik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done @mnapoli and great call 👍 Would you be okay with adjusting the documentation for aws-python-sqs-worker in the same way? I believe it should be pretty much copy-and-paste as these parts of the doc are the same for both examples

@mnapoli
Copy link
Contributor Author

mnapoli commented Jul 12, 2021

Ah good point, thanks for that! I've pushed the same changes in the Python example too (mirrored the 2 READMEs).

Copy link
Contributor

@pgrzesik pgrzesik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @mnapoli 🙇

@pgrzesik pgrzesik changed the title Improve the documentation of the SQS node example docs: Improve the docs of the aws-*-sqs-worker examples Jul 12, 2021
@pgrzesik pgrzesik merged commit 7f4ad28 into master Jul 12, 2021
@pgrzesik pgrzesik deleted the improve-sqs-example-documentation branch July 12, 2021 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants