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

add: service docs readme #1425

Merged
merged 5 commits into from
Nov 29, 2023
Merged

Conversation

AvaterClasher
Copy link
Contributor

@AvaterClasher AvaterClasher commented Nov 26, 2023

Description of change

Added a README.md for the doc comments in the shuttle-actix-web crate.
Modified the crate to include the README.md during doc compilation.

Closes #1395

How has this been tested? (if applicable)

Verified

This commit was signed with the committer’s verified signature.
adamdehaven Adam DeHaven
@AvaterClasher
Copy link
Contributor Author

@jonaro00 Can you please take a look if this is how you intended it to be done ?

Copy link
Member

@jonaro00 jonaro00 left a comment

Choose a reason for hiding this comment

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

Yes, looks great apart from this detail:

services/shuttle-actix-web/README.md Outdated Show resolved Hide resolved
@AvaterClasher AvaterClasher marked this pull request as ready for review November 27, 2023 07:10
Copy link
Member

@jonaro00 jonaro00 left a comment

Choose a reason for hiding this comment

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

LGTM! Don't worry about the serenity CI fail.

@jonaro00 jonaro00 merged commit 207a63c into shuttle-hq:main Nov 29, 2023
@AvaterClasher
Copy link
Contributor Author

@jonaro00 How does one get the contributer role in discord ?

@AvaterClasher AvaterClasher deleted the service-docs branch November 29, 2023 15:33
@jonaro00
Copy link
Member

You can ask in #contributors and I'll tell admins to add you and other new contributors.

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.

[Improvement]: Unify service doc comments and crate docs with README files
2 participants