Skip to content

doc: add documentation overview for grpc, file and datasource packages #1947

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 17 commits into
base: development
Choose a base branch
from
Open

doc: add documentation overview for grpc, file and datasource packages #1947

wants to merge 17 commits into from

Conversation

olxandr
Copy link
Contributor

@olxandr olxandr commented Jun 30, 2025 •
edited
Loading

Fixes #1946

Description:
This PR is adding a gofr/grpc, gofr/file and gofr/datasource packages overview so it appears on pkg.go.dev.

Screenshots

gofr/grpc
Before:

Image

After:
Screenshot From 2025-07-01 12-25-49 (1)

gofr/file
Before:

Image

After:
Screenshot From 2025-07-01 12-41-17 (1)

gofr/datasource
Before:

Image

After:
Screenshot From 2025-07-01 12-36-24 (1)

  • I have formatted my code using goimport and golangci-lint.
  • This PR does not decrease the overall code coverage.
  • I have reviewed the code comments and documentation for clarity.

olxandr added a commit to olxandr/gofr that referenced this pull request Jun 30, 2025
@olxandr
doc: gofr/datasource package documentation overview gofr-dev#1947
1fee96d
@coolwednesday
Copy link
Member

@olxandr, We would like substantial contribution through each PR. Please merge your three PRs into one ... It would also be helpful for reviewers if you add previous and current screenshots. Thank you!

coolwednesday
coolwednesday requested changes Jul 1, 2025
View reviewed changes
Copy link
Member

@coolwednesday coolwednesday left a comment

Choose a reason for hiding this comment

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

Add screenshots of before and after !

@olxandr olxandr marked this pull request as draft July 1, 2025 08:49
@olxandr olxandr requested a review from coolwednesday July 1, 2025 09:29
@olxandr olxandr marked this pull request as ready for review July 1, 2025 09:31
coolwednesday
coolwednesday requested changes Jul 1, 2025
View reviewed changes
Copy link
Member

@coolwednesday coolwednesday left a comment

Choose a reason for hiding this comment

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

Refer - #1947 (comment)

This was referenced Jul 1, 2025
Closed
Closed
@olxandr olxandr changed the title doc: gofr/grpc package documentation overview doc: add documentation overview for grpc, file and datasource packages Jul 1, 2025
@olxandr olxandr requested a review from coolwednesday July 1, 2025 12:30
@olxandr
Copy link
Contributor Author

olxandr commented Jul 1, 2025 •
edited
Loading

@coolwednesday Sure, the PRs are merged into the current one. This is the main PR now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coolwednesday coolwednesday Awaiting requested review from coolwednesday

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: missing documentation for grpc, file and datasource packages
3 participants
@olxandr @coolwednesday @Umang01-hash