Tuesday, May 13, 2025
HomeGolangPictures (diagrams, svg or drawio photos) in godoc? - Getting Assist

Pictures (diagrams, svg or drawio photos) in godoc? – Getting Assist


Is it attainable to embed diagrams in godoc ? how can I doc the person flows ?

My want is the next: I wish to doc each what this knowledge constructions does, within the file the place it’s outlined, and likewise discuss concerning the utilization flows through which this knowledge construction is used. Keep in mind that it is a complicated knowledge constructions, with many (greater than 5) utilization flows.

Maybe there’s a software construct on high of godoc which permits me to attain this ? Or maybe I can use ascii artwork/some format to attain this objective ?

Has anybody discovered a solution to doc movement diagrams with godoc ?

That sounds prefer it is perhaps higher suited by a README.md or one thing alongside these traces. Godoc is nice for documenting your code, but it surely doesn’t should be the solely documentation in your challenge. For instance, the go repo itself has a godoc in addition to go.dev which expands on plenty of ideas and comprises weblog posts, and many others.

RELATED ARTICLES

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Most Popular

Recent Comments