Skip to content

refactor: better jsonschema docs generation#108

Merged
xynydev merged 4 commits intomainfrom
schema-docs
Jan 30, 2026
Merged

refactor: better jsonschema docs generation#108
xynydev merged 4 commits intomainfrom
schema-docs

Conversation

@xynydev
Copy link
Member

@xynydev xynydev commented Jan 5, 2026

Ended up rolling my own solution.

Some warts still, but already way better than the previous version.

Once the preview deploy is out, y'all can see the new format the generated docs take. Might need some discussion still, I am not 100% on this.

TODO

  • Make array item type thingy work better
  • Finalize format
  • Also generated module and recipe ref pages with this

@github-actions
Copy link

github-actions bot commented Jan 5, 2026

💙 Build successful! 💙

Preview deployment: https://schema-docs-bluebuild-website.xyny.workers.dev/

@gmpinder
Copy link
Member

gmpinder commented Jan 5, 2026

Would it be possible to have the valid values use bullet points?
image

@gmpinder
Copy link
Member

gmpinder commented Jan 5, 2026

I think it would help the reader understand what's a property if you did something like property:. Or maybe we have the full property path in the header? Like:

#### `configurations[].notify`, `boolean`

I feel like a path would make the structure clearer than having to rely on counting the number of # in the header.

@xynydev
Copy link
Member Author

xynydev commented Jan 24, 2026

Latest push made this again way better (and pretty robust). I think this could be a possible final version as well. I could not get the full property path version working today yet, but maybe I'll be able to get it to work another day if we still find that necessary.

@xynydev
Copy link
Member Author

xynydev commented Jan 26, 2026

Yeah, I think this PR is done now. I find it readable enough without the property syntax you suggested, though I am still open to implementing that in the future. The recipe schema also needs some additions and cleanup, though, to make this version of the docs as good as the last one.

I'll mark this ready for review, but wont merge until schema changes are made.

@xynydev xynydev marked this pull request as ready for review January 26, 2026 18:33
@xynydev
Copy link
Member Author

xynydev commented Jan 26, 2026

Generating docs for the generic module ref page is unfortunately not possible right now, as we do not generate a JSONSchema that would match that page's contents in any desirable way. May be supported in the future with the code improvements in this PR, though.

@xynydev
Copy link
Member Author

xynydev commented Jan 27, 2026

Prerequisite PR blue-build/schema#15

@xynydev xynydev merged commit 635b3b8 into main Jan 30, 2026
3 checks passed
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.

2 participants