-
Notifications
You must be signed in to change notification settings - Fork 90
chore: migrate docs from gatsby to mkdocs #308
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
Conversation
41dbb33
to
bae197a
Compare
0d58175
to
3e56f2b
Compare
3e56f2b
to
e864323
Compare
I don't think I can review this, bit out of my knowledge range. @heitorlessa maybe? |
Tip - Add a preview URL from your branch Pankaj at the top of the PR
description —- that way Mark can review its content.
It’s good opportunity to clean up and make navigation easier etc
…On Tue, 2 Mar 2021 at 09:31, Mark Sailes ***@***.***> wrote:
I don't think I can review this, bit out of my knowledge range.
@heitorlessa <https://github.com/heitorlessa> maybe?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#308 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAZPQBHGRFWNROVAATHHSYDTBSO5RANCNFSM4YNG7Z3A>
.
|
Yeah I already added preview link in the description |
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.
There is one general thought I had when going through the docs. Many code examples don't contain the import statements. While we don't have to bloat the import section of the examples, it is helpful to mention at least the imports from the powertools library. Sometimes IDE can't autoimport, sometimes the class names might be similar within other packages. I had this experience few times when reading other docs and was frustrated to understand where specific classes are coming from.
@am29d Thanks for great suggestions. I believe I have all of them in place now. Give it another shot. Live preview is updated as well https://me.pankaagr.cloud/aws-lambda-powertools-java/ |
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.
LGTM
Issue #, if available:
Description of changes:
Preview available here https://pankajagrawal16.github.io/aws-lambda-powertools-java/
Checklist
Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.