May 3, 2023, 5:06 p.m. | Amara Graham

DEV Community dev.to

Documenting configuration directly on the config file is great, right? Everything is right there.


Ehh.


This could probably be repackaged.





Why embark on this journey?


You can Ctrl + F (or Command + F) your way through the file, but you have to know what you are looking for.


You could argue an intuitive experience and naming strategy would work well in this situation, but that's a stretch, particularly when talking about advanced config. A great goal, but really …

documentation journey markdown moving through yaml

Data Architect

@ University of Texas at Austin | Austin, TX

Data ETL Engineer

@ University of Texas at Austin | Austin, TX

Lead GNSS Data Scientist

@ Lurra Systems | Melbourne

Senior Machine Learning Engineer (MLOps)

@ Promaton | Remote, Europe

Software Engineer, Data Tools - Full Stack

@ DoorDash | Pune, India

Senior Data Analyst

@ Artsy | New York City