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

Documentation roadmap #13

Open
12 tasks
Supinic opened this issue May 2, 2021 · 1 comment
Open
12 tasks

Documentation roadmap #13

Supinic opened this issue May 2, 2021 · 1 comment
Assignees
@Supinic
Labels
documentation Improvements or additions to documentation

Comments

@Supinic
Copy link
Owner

Supinic commented May 2, 2021

Classes

  • Template
  • Command
    • Context
  • User
  • Channel
  • Platform
  • ChatModule
  • Cron
  • AFK
  • Banphrase
  • Filter
  • Config

Documentation for supi-core is lacking, this roadmap presents in which order these should be documented.
@Supinic Supinic added the documentation Improvements or additions to documentation label May 2, 2021
@Supinic Supinic self-assigned this May 2, 2021
@Supinic
Copy link
Owner Author

Supinic commented May 2, 2021

I think the way to go is to create a CI that will parse out JSDoc from each file and create an auto-generated .md file for each class

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Supinic Supinic

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Supinic