Skip to content

Commit

Permalink
Notes on a failure
Browse files Browse the repository at this point in the history
  • Loading branch information
bjackman committed Nov 22, 2024
1 parent 2f4bd00 commit 3181929
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion CHAOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,21 @@ My janky test command:

```
RUST_LOG_STYLE=always RUST_LOG=debug cargo watch -- bash -c "cargo test --color=always -- |& less -R -F -c"
```
```

## Documenting the config schema

I thought I was terribly clever because I was able to generate a JSON schema for
the configuration, I thought it would make it very easy to generate docs for
that schema.

Unfortunately, it isn't. The internet is strewn with tools that generate static
HTML from your JSON schema, all of them seem to be useless. Everything requires
you to use `npm` or `yarn` or `pip` (I know this tool currently requires you to
use `cargo`, but I don't think that's OK). Many don't work at all. Most seem to
generate stupid HTML with animations and silly nonsense like that.
[`json-schema-static-docs`](https://tomcollins.github.io/json-schema-static-docs/)
seems to generate nice HTML, but its UI seems to be "write some JavaScript"
so... fuck that.

I will not be generating nice HTML for the config schema.

0 comments on commit 3181929

Please sign in to comment.