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

Golang docs #442

Merged
merged 17 commits into from
Sep 4, 2024
Merged

Golang docs #442

merged 17 commits into from
Sep 4, 2024

Conversation

jackkleeman
Copy link
Contributor

@jackkleeman jackkleeman commented Aug 15, 2024

The best way to review this is just to look at the preview

Copy link

cloudflare-workers-and-pages bot commented Aug 15, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4bb79f3
Status: ✅  Deploy successful!
Preview URL: https://63e8676d.documentation-beg.pages.dev
Branch Preview URL: https://golang.documentation-beg.pages.dev

View logs

Copy link
Contributor

@slinkydeveloper slinkydeveloper left a comment

Choose a reason for hiding this comment

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

Left some minor comments, from my side the code looks good!

docs/develop/go/overview.mdx Outdated Show resolved Hide resolved

Request-response calls are requests where the client waits for the response.

<CH.Scrollycoding className={"single-item"}>
Copy link
Contributor

Choose a reason for hiding this comment

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

there is a problem with tab here, not sure what

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not sure what you mean

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

image

A lot of space taken there for the text on the left, could be used by the code

docs/develop/go/service-communication.mdx Show resolved Hide resolved
docs/develop/go/journaling-results.mdx Outdated Show resolved Hide resolved
docs/develop/go/journaling-results.mdx Outdated Show resolved Hide resolved
docs/get_started/tour.mdx Outdated Show resolved Hide resolved
docs/get_started/tour.mdx Outdated Show resolved Hide resolved
@jackkleeman jackkleeman changed the title Golang develop docs Golang docs Aug 22, 2024
@slinkydeveloper
Copy link
Contributor

I have one general comment that the indentation is too much... e.g. this:

image

Compared to this:

image

This is especially visible in snippets with fairly long-ish lines... Can you configure go fmt to use 2 spaces instead of 4?

@gvdongen
Copy link
Contributor

I think the checking of the go code snippets still needs to be added to the github workflows as well

@gvdongen
Copy link
Contributor

And we should add Go icons to the overview page here: https://golang.documentation-beg.pages.dev/

@jackkleeman
Copy link
Contributor Author

@slinkydeveloper go uses tabs, i will check how to get our code blocks to display them tighter

@jackkleeman jackkleeman merged commit 0b3392f into main Sep 4, 2024
2 checks passed
@jackkleeman jackkleeman deleted the golang branch September 4, 2024 08:48
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.

3 participants