formal XMIR specification must be generated from the XSD

[volodya-lombrozo]

I usually work closely with xmir files. So, I need to understand this format to be able to work with it. However, I failed to find any developer specification on this format. It is extremely important to have this specification, otherwise any work with xmir becomes fortune telling on coffee grounds.

As far as I know we have some separate knowledge isles like comments or blog posts (it's written in 2022 btw).

But it's extremely hard to find them. Actually you need to know where to find them. And it is the only chance.
I suggest to create a centralised documentation for xmir format.

[volodya-lombrozo]

@yegor256 @maxonfjvipon Could you take a look, please?

[yegor256]

@volodya-lombrozo we intentionally did it like this (with a blog post) because the format is still rather volatile: we change it once in a while. I suggest we keep it like this, only updating the blog post when something is missing or changing. If you have questions to any parts of the XMIR format, ask them, I will update the blog post.

[yegor256]

@maxonfjvipon in the mean time, can we add a text to all error messages that are related to XMIR:

More detailed information about XMIR format you can find here: https://news.eolang.org/2022-11-25-xmir-guide.html

This will help everybody.

[volodya-lombrozo]

@yegor256 There are some problems with the blog post:

• It lies separately from the repository. Where can I find a link to it?
• It is attached to a particular date 25 Nov 2022. So when I see it, I assume that it is outdated already. And it is outdated indeed.
• You can't create several separate documents and link them - you need to keep everything at one place. "God Documentation File" :)
• nit: The format is a bit different, it is not what you expect from the technical documentation.

[yegor256]

@volodya-lombrozo maybe we can generate documentation right from our XSD: https://stackoverflow.com/questions/237938/how-to-convert-xsd-to-human-readable-documentation

[volodya-lombrozo]

@volodya-lombrozo maybe we can generate documentation right from our XSD: https://stackoverflow.com/questions/237938/how-to-convert-xsd-to-human-readable-documentation

Sounds cool