Skip to content
Open
Show file tree
Hide file tree
Changes from 58 commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
48b424b
first pass at auto-generating documentation; add hearts-and-flowers a…
cherriechang Mar 18, 2025
0f76471
auto-generate non-flat version of docs
cherriechang Mar 18, 2025
aa620ff
expand parameters and objects and display items in timelineUnits and …
cherriechang Mar 18, 2025
75b25d5
add files for post-processing auto-generated docs
cherriechang Mar 25, 2025
2d79a0b
post-processing for main timeline docs done
cherriechang Mar 25, 2025
be1bb66
change update-readme.js to generate-docs.js
cherriechang Mar 25, 2025
b183e03
delete update-readme.js, update package.json to include generate-docs…
cherriechang Mar 25, 2025
8f7e0d5
delete merge-readme.js
cherriechang Mar 25, 2025
f80c4ff
happy with interface filtering, timelineUnits filtering and timeline …
cherriechang Mar 25, 2025
d7fc5fa
finish all 3 levels filter functions; updated update-readme script in…
cherriechang Mar 25, 2025
843a735
hearts and flowers documentation follows order
cherriechang May 13, 2025
06cb1b5
fix package.json update-readme script to run all scripts not just first
cherriechang May 29, 2025
870742e
adjust heading levels in createTimeline.md generation; add udpate-rea…
cherriechang May 29, 2025
c2cd138
update update-readme.js to copy over timelineUnits and utils document…
cherriechang May 29, 2025
ffba82e
properly update readme and delete unnecessary docs folder in hearts-a…
cherriechang Jun 9, 2025
02a5d3f
add two missing readme-scripts to template-ts
cherriechang Jun 9, 2025
4c236d6
add changeset
cherriechang Jun 9, 2025
ab9dc64
delete hearts-and-flowers
cherriechang Jun 9, 2025
fd25469
delete root-level update-readme.js in timeline-template-ts
cherriechang Jun 10, 2025
e7f02e9
delete dist/ from jspsych-dev root .gitignore
cherriechang Jun 10, 2025
4928091
add .gitignore to templates; modify each tool's cli to copy over hidd…
cherriechang Jun 10, 2025
669cc35
fix publishing comment in examples/index.html of new-plugin and new-e…
cherriechang Jun 10, 2025
650704b
add node_modules/ to .gitignore of all templates
cherriechang Jun 10, 2025
f191f33
Move generate-timeline-docs to its own package, update template packa…
cherriechang Jun 12, 2025
ba5f754
Fix logic for testing locally; remove console log indentations
cherriechang Jun 13, 2025
dcfc6d9
fix timeline template package.json to properly install generate-timel…
cherriechang Jun 13, 2025
8558e71
fix generate-timeline-docs main script to load node modules directly …
cherriechang Jun 13, 2025
ea448e5
add name field to package.json
cherriechang Jun 13, 2025
bbf82c8
delete root typedoc.json
cherriechang Jun 13, 2025
ee9dd14
tool currently updates internal links for functions or variables to i…
cherriechang Jun 16, 2025
b5262db
Revert "tool currently updates internal links for functions or variab…
cherriechang Jun 16, 2025
a29f81c
separate each step in generate-timeline-docs; took out dependency app…
cherriechang Jun 18, 2025
4f882d1
add dependency graph class
cherriechang Jun 18, 2025
4b0cc58
add function in doc-dependency-graph.js to loop through all files in …
cherriechang Jun 18, 2025
83a28c5
Change to loop through all files in interfaces/ and filters them + ap…
cherriechang Jun 18, 2025
cdc3d8c
add terminating heading to end of each interface
cherriechang Jun 18, 2025
987df68
process-interfaces-docs only returns false if interfaces/ doesn't exi…
cherriechang Jun 18, 2025
fbb96d3
process-functions-docs applies filtering to all .md files in function…
cherriechang Jun 18, 2025
1052075
finish generalizing all processing to all .md files in functions/ var…
cherriechang Jun 18, 2025
f5cbcc1
filtering + link normalization works
cherriechang Jun 18, 2025
8077358
have to deal with fragments
cherriechang Jun 18, 2025
67df595
correct order of processing being generated
cherriechang Jun 18, 2025
402bde8
add individual sections in docs files to graph
cherriechang Jun 20, 2025
b0a9c48
correct, section-based dependency order being generated
cherriechang Jun 20, 2025
610db7a
finish auto-gen docs with recursive dependency appending
cherriechang Jun 20, 2025
d1fcefe
convert to using commander so that tool options can be customized in …
cherriechang Jun 20, 2025
e499218
add doc marker as argument to tool
cherriechang Jun 20, 2025
0682c5c
modify update-readme to append generated docs after specified heading…
cherriechang Jun 20, 2025
db3516e
fix regex to allow for backticks in createTimeline()
cherriechang Jun 20, 2025
d357654
add src/index.js as an entry point for typedoc
cherriechang Jun 20, 2025
46d825b
update generate-typedoc-docs to loop through entrypoints in config; a…
cherriechang Jun 20, 2025
d8e13e9
Allow relative path as package-directory argument
cherriechang Jun 21, 2025
5d051e2
update default docStart to ## Documentation, start docs at one level …
cherriechang Jun 21, 2025
35b6047
readme mostly done except boring jsdoc stuff; fix code to also append…
cherriechang Jun 22, 2025
e498ee7
fix internal links
cherriechang Jun 22, 2025
2c6eb54
jsdoc annotations readme part done
cherriechang Jun 22, 2025
a226699
add comment that interfaces can only be used in typescript files
cherriechang Jun 24, 2025
0a87413
update readme
cherriechang Jul 9, 2025
de9c557
commit changesets
cherriechang Jul 17, 2025
08846f7
fix: updated package-lock.json
cherriechang Oct 14, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/healthy-birds-sell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@jspsych/new-timeline": minor
---

Added an npm script for generating and updating documentation for main exports in timelines automatically, removing need for user to manually write documentation.
Loading