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

Document base classes and interfaces #1088

Closed
5 tasks done
codyoss opened this issue Oct 18, 2021 · 1 comment
Closed
5 tasks done

Document base classes and interfaces #1088

codyoss opened this issue Oct 18, 2021 · 1 comment
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Milestone
v13

Comments

@codyoss
Copy link
Member

codyoss commented Oct 18, 2021 •
edited by chingor13
Loading

The model of this project is such that when adding new components you need to extend a base implementation or implement an interface. It would be nice if these foundational classes could be documented so that when a person is adding new components they could read docs on how fields are used instead of having to jump around to different areas in the source to find out this information.

  • Plugin
  • Strategy
  • Updater
  • Version
  • VersioningStrategy
@bcoe bcoe added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Oct 19, 2021
@bcoe
Copy link
Contributor

bcoe commented Oct 19, 2021

@codyoss @chingor13 I agree, we should consider running jsdoc and publishing to GitHub pages.

@chingor13 chingor13 added this to the v13 milestone Nov 29, 2021
This was referenced Dec 20, 2021
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
v13
Development

No branches or pull requests
3 participants
@chingor13 @bcoe @codyoss