suggestion: make style similar to godoc

[SVilgelm]

It would be great to have a style same, or very similar, as godoc. Most people are familiar with that style and I faced an issue when I had to explain to people that the exported methods are expandable and they can see more documentation after clicking a plus sign.

[zigo101]

Do you mean many people expect that the docs of methods should be all expanded initially?

[SVilgelm]

I mean many people are already familiar with the style, that godoc or pkg.go.doc use, and they expected something similar

[zigo101]

It is hard to make their styles very alike, for godoc provides much less information for types than golds. In fact, godoc only lists methods as the only property of types. (Whereas golds lists fields, asOutputsOfFunctions, asInputsOfFunctions and asTypesOfValues as well.)

One the other hand, they could be more similar later than now in some extend. The things I can think of may be made to increase the similarity are:

• add an index section
• always expand the current collapsed content
• show code examples

Do you think these will help? Or do you have any other ideas to increase the similarity?

[ffmiruz]

Index would be nice. Also bigger font maybe. Matching the font at https://golang.org/pkg/ (Roboto 16px, 1.3em line height)

[zigo101]

v0.2.0 is released with some UE adjustments and several small new features.

[nikolaydubina]

I actually like this style more! It is good to have some alternative to godoc! Albeit, lately pkg.go.dev is just outstanding, something like it would be amazing.

[3052]

this is not exactly the old style, but its much similar than the current Golds incarnation:

https://github.com/abhinav/doc2go

[zigo101]

@3052 I admit Golds is still far to perfection, but Golds has too many differences from godoc that it is hard to make their UI style very similar.

Golds was mainly developed for my own need: study some Go projects by reading their code. Generating package public APIs is more a by-product.

For lack of enough spare time and I don't see a bright future for Go any more, I will spend much less time on this project, especially on adjusting the UI style. I'm sorry for this. Everybody can fork this project to make changes according their needs.

[3052]

For lack of enough spare time and I don't see a bright future for Go any more, I will spend much less time on this project, especially on adjusting the UI style.

in that case, make me owner of https://github.com/go101/golds, and I can address the issues

[zigo101]

You can fork it and do whatever you want. :)

[3052]

too much effort. I will just continue to use Doc2Go