Skip to content

initial release of the autodoc tool#55

Draft
jadeddelta wants to merge 1 commit into
mainfrom
autodoc
Draft

initial release of the autodoc tool#55
jadeddelta wants to merge 1 commit into
mainfrom
autodoc

Conversation

@jadeddelta
Copy link
Copy Markdown

release for @jspsych/autodoc, a CLI tool for automatically generating documentation based off of jsPsych plugins, extensions, and timelines.

as of the first commit, it works via running it with a --source and --dest flag for the source files and destination files, alongside an optional --example flag for if you have examples (one file or a directory) to tie with the source file.

things we will offer (and a handy TODO list):

  • generate documentation based off of plugin files
  • generate documentation based off of extension files
  • generate documentation based off of timeline files
  • system to allow for customizable templates: i.e. one for jspsych core repo, one for contrib, and then the ability to have other orgs write and run their own templates.
  • automatic inference on if a file is a plugin, extension, or timeline
  • clear documentation on every part, what the outputs are and quirks of the system

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 28, 2026

🦋 Changeset detected

Latest commit: e0fc6b4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@jspsych/autodoc Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

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.

1 participant