metalbear-co / mirrord

Connect your local process and your cloud environment, and run local code in cloud conditions.
https://mirrord.dev
MIT License
3.74k stars 101 forks source link

medschool: generate config field headings automatically #1772

Open t4lz opened 1 year ago

t4lz commented 1 year ago

Currently, in order to create the the headings (with anchor links) of configuration fields, e.g: image

We need to write that heading in the Rust documentation, e.g: https://github.com/metalbear-co/mirrord/blob/56da9828ad2553e6c5a11124c5d65f4d4b00e6e6/mirrord/config/src/lib.rs#L181

Which is redundant, because we write the name of the field in a comment above the field, and it also leads to weird Rust docs with that same redundancy and weird item id: image

I think medschool should derive the heading and anchor link without us writing it in the Rust docs.

infiniteregrets commented 1 month ago

I can take this one!

eyalb181 commented 1 month ago

Thanks!