Public

Val Town is a collaborative website to build and scale JavaScript apps.

Deploy APIs, crons, & store data – all from the browser, and deployed in milliseconds.

Code

docs-todos.md

11/1/2025

Viewing readonly version of main branch: v147

View latest version

docs-todos.md

Build Documentation Generator

Do one task at a time. Start the task. Confirm it works in the browser. Mark it done. Do the tasks in order.

Bug: when you click on a function in a narrow width screen, the sidebar overlays the content.
The parameters need to be named in the parameter section.
In the parameters section, any code (ie backticks) should be syntax-highlighted as blocks.


 Bug: Figure out how to get text-sm to affect  blocks with syntax
highlighting. Right

 The syntax highlighting looks a little weird with background color of
white on certain elements.
 Add a copy button on the example
 Add precise type information for all inputs and outputs. Users should know
exactly every field of every input and every output type. This should be
easy given the typescript info we have on all inputs and ouputs. If any
are underspecified, let me know.



Experimental unification of tests & examples into JSDoc strings

 Let's redo all the tests as jsdoc string examples as inspired by Deno
here:
https://docs.deno.com/runtime/fundamentals/testing/#example-code-blocks

 Create a syntax for example input and example output that we can parse
as tests and also as examples for the docs
 Audit all of our existing tests to see which of them can be easily
migrated over and which need more work.
 In _docs.tsx, parse and run all the tests
 At the top of the the docs page, render a summary badge of all the test
results
 In each function, render a summary badge of its test results, if error,
let me click to expand to see the error
 In each function, list each of its 'tests' as an example usage, show the
input and output
 Only show the first 2 usages for each function, but have a show more
button to see them all.
 For each of the examples, link to the source for it in the codebase
 For each example, show the test result status for it and any potential
 Inject import line for that function in each example for easier copying
something that holistically works error message
 For all test result badges, experiment with showing the timestamp the
test was run at to convey how live this system is (ie runs on every page
load)
 Delete the old test.tsx file

stevekrouse

utils

Build Documentation Generator

Experimental unification of tests & examples into JSDoc strings