how high the priority to make sure this catches up with spec-4.x features?

[simkimsia]

I understand that this is currently beta as of 2026-09-14 Monday, but I wonder what's the maintainers idea about reaching parity with spec-4.x features in the toon format?

[alesanfra]

Hi @simkimsia, the new version 1.0.0 is fully spec 4.1 compatible, and ready to be deployed to pypi. Meanwhile you can install the module directly from this repo.

Thanks for your interest in this project!

[alesanfra]

Thanks a lot for offering to help, @simkimsia. That's really appreciated!

My aim for this project is to keep it as minimal as possible, so new features and utilities are out of scope. There's more detail in the .out-of-scope folder. As you've probably noticed yourself, we've struggled to maintain this repo over the past year. The smaller the code surface, the lighter the burden on maintainers.

That said, there are three areas where help would be very welcome:

1. Keeping the repo up to date with the spec and test fixtures. This can be a fairly mechanical task, but help from the community here is always valuable.
2. Reporting and fixing bugs. This one's obvious, but there may be odd behaviours the official fixtures don't catch. A bug report is always welcome. A draft PR with a test that reproduces the bug, plus the fix, is even better. Keep an eye on the issues page, because any new bug could be a good place to start.
3. Improving the documentation. The most successful Python projects, such as FastAPI and Pydantic, have excellent documentation. The toon-format API is quite small, but well-crafted docs are always welcome. Using LLMs isn't off-limits, quite the opposite, but we need people to read the output carefully and improve anything that's unclear. I've also published the docs on Read the Docs. A nice small first task would be adding that link to pyproject.toml and the README, or wherever else it's needed.

TL;DR: keep it minimal, and fix and improve what already exists.

Thanks again, and any contribution is very welcome!

[simkimsia]

Thanks for writing this down to be so clear. Just to be clear, when you say

nice small first task would be adding that link to pyproject.toml and the README, or wherever else it's needed.

you mean adding https://toon-format.readthedocs.io/en/stable/ to pyproject.toml and README?

[simkimsia]

I went ahead and opened #75 for this: the Documentation URL in pyproject.toml, the Documentation and migration links in the README, and a Read the Docs badge now point to https://toon-format.readthedocs.io/en/stable/.

I also updated the note in CONTRIBUTING.md that said the Read the Docs project did not exist yet, since it was created with the slug toon-format rather than toon-python.

Happy to adjust anything.

[alesanfra]

LGTM, merged. Thank you!

[simkimsia]

i love how responsive you are, @alesanfra thank you 🙇🏻‍♂️