Skip to content

Add basic documentation on service classes #5858

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented May 23, 2025

Explanation

As more and more people make changes to this repo, the need to understand services has grown.

This new document offers a tutorial that explains what a service does, how to create a service, and how to use it in a project.

References

Progresses #5741.

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@mcmire mcmire force-pushed the add-docs-on-service-classes branch 2 times, most recently from d9a6511 to 3881849 Compare May 23, 2025 20:12
@mcmire mcmire marked this pull request as ready for review May 23, 2025 22:14
@mcmire mcmire requested a review from a team as a code owner May 23, 2025 22:14
@mcmire mcmire changed the title Add docs on service classes Add basic documentation on service classes May 23, 2025
As more and more people make changes to this repo, the need to
understand services has grown.

This new document offers a tutorial that explains what a service does,
how to create a service, and how to use it in a project.
@mcmire mcmire force-pushed the add-docs-on-service-classes branch from 3881849 to 584990c Compare May 23, 2025 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant