go-netbox icon indicating copy to clipboard operation
go-netbox copied to clipboard

Broken links in README.md

Open CvR42 opened this issue 7 months ago • 0 comments

The README.md file contains the sentence:

See docs or reference for more information on all possible usages.

The link to `docs' is broken.

The reference' link points to the same content as the README, but without the link to docs'.

I am still hoping that there is some kind of documentation for newbies like me, because without it the learning curve of go-netbox is something like the cliffs of Dover. From what I understand, the module consists for 99% of code that is automatically generated from the netbox API. Just explaining this already helps a lot. Pointers to language-independent explanations of how to use the netbox API and perhaps a simple simple explanation of API to go-code mapping would also help. A few more examples would also help.

There is another broken link in this sentence of README.md:

Therefore, files listed here should not be directly modified, as they will be overwritten in the next regeneration (see next section).

CvR42 avatar May 27 '25 11:05 CvR42