feat(schema): autogenerate manifest reference docs#6453
Conversation
|
Thanks for working on this! This is only part of the solution. The goal is to use the schema as a baseline and adapt it further with custom content to add more explanation, examples, etc. If we were to merge this, we'd have two separate pieces of documentation:
That doesn't add much value. |
|
Thanks for the feedback! Makes sense, I'll rework this so we have a single, cohesive documentation page that uses the schema as the baseline structure and injects the manual examples and explanations into it. |
|
Or if we can add richer information to the schema itself that would also be good! Examples and such. Not sure how much of this is possible with json schema though. |
|
Yeah, enriching model.py is a good idea since it improves both the docs and the JSON schema for IDE users. Pydantic's Field() already supports examples and many fields already use it, so we can build on that and make the generated output richer. |
0cf5739 to
cbd41cb
Compare
|
PTAL @baszalmstra Thanks! |
Description
Adds a Python generator script (schema/generate_manifest_docs.py) that introspects the Pydantic models in model.py to auto-generate structured Markdown reference documentation for pixi.toml. Mirrors the existing CLI auto-generation pattern and includes CI checks to ensure documentation stays up to date.
Fixes #3021
How Has This Been Tested?
AI Disclosure
Tools: Claude
Checklist:
schema/model.py.