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

docs(readme): add pkg-docs link feat markdown enhancement #310

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

danielhe4rt
Copy link

GoCQL README Page


Here's some small improvements to the README.md file, where I just managed to enhance some small point which was point to pkg-go docs.

Why I made this change?

I'm quite new to Golang and still learning about the environment yet. As expected from our Drivers, I tried to find our Sphinx Docs with more specifications with no luck.

Documentation Enhancements:

  • Added a centered header and badges for build status, documentation, and protocol specs to improve the visual appeal and accessibility of important links.
  • Introduced a table of contents to help users navigate through the document more easily.
  • Reformatted section headers and added sub-sections for better clarity and organization.
  • Included a new "Contributing" section to guide users on how to contribute to the project.

@danielhe4rt
Copy link
Author

@annastuchlik @sylwiaszunejko please, review.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@danielhe4rt
Copy link
Author

@dkropachev did some soft reset without the identation changes.

@dkropachev
Copy link
Collaborator

@danielhe4rt , thanks

@sylwiaszunejko sylwiaszunejko merged commit 53c3579 into scylladb:master Oct 17, 2024
1 check passed
@annastuchlik
Copy link

@danielhe4rt Great, thanks Daniel.

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.

4 participants