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.

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

[Feature Request]: Document API components #972

Open
rkingsbury opened this issue Jun 21, 2024 · 0 comments
Open

[Feature Request]: Document API components #972

rkingsbury opened this issue Jun 21, 2024 · 0 comments
Labels
docs documentation

Comments

@rkingsbury
Copy link
Collaborator

Problem

There is currently no documentation of maggma.api. We should add documentation of these components and also add a corresponding overview section to the README file.

Proposed Solution

  • Overview paragraph in README
  • Overview paragraph in the Concepts section
  • Detailed reference documentation similar to what we have for Store and Builder

Alternatives

No response
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rkingsbury