feat: add maintenance to the reference

[letFunny]

The idea is that the reference for maintenance will be shown when using unmaintainted or unstable releases, see canonical/chisel#238 (comment) for context.

The goal of this PR is to write down all ideas and to see if the reference is a good page to show in Chisel's output (again, see github comment above for context).

[cjdcordeiro]

this is v2 specific right? So I think we need to also update the top of chisel.yaml.md, to add and the format version, and maybe add a column to these new attributes, to state that they are only available in v2

[cjdcordeiro]

Thanks for the changes @letFunny . I think we still need the change related to the introduction of v2

[letFunny]

Thanks for the changes @letFunny . I think we still need the change related to the introduction of v2

I misunderstood your other comment then in MM. I thought we were going to add versioning to the docs in the sense of browsing docs per chisel version. I will add a column here for compatibility, maybe saying >= v2.

[letFunny]

@cjdcordeiro I have added the attribute "compatibility" for all values with either:

• v1 if it is deprecated like "default".
• >= v1.
• >= v2.

Please tell me what you think. An alternative would be to only include for fields where it is not the default but I think it is better to be consistent and put it everywhere.

[cjdcordeiro]

It looks nice, thanks!

Y the docs versioning is a separate complement, since it covers anything within Chisel (e.g. CLI changes, UX changes, etc.) while this part here is just about the chisel.yaml.

I'm a bit concerned about the maintainability of these tables, cause as we add/remove stuff, it will be really easy to mess up the compatibilities. I wish this could be generated from code, but it's good enough for now.

Thanks again

[cjdcordeiro]

Feel free to merge once the Chisel counterpart is merged too