fsprojects / FSharp.Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/
Other
462 stars 155 forks source link

discussion: offering back links form API pages to the other documentation pages? #829

Open smoothdeveloper opened 12 months ago

smoothdeveloper commented 12 months ago

Say I somehow landed on this page: https://fslab.org/FSharp.Stats/reference/fsharp-stats-testing-sam.html

I'd like from this page to be offered a back link to https://fslab.org/FSharp.Stats/Testing.html#SAM (and maybe others) because it is a page that has code samples that pulls the module or has references to member of it.

I don't know if this sounds unreasonable (would generate too many links), so there is probably a bit of experimentation to find out if this could be tuned to work well with defaults.

I am also wondering if there is a way to deal with adding such links in the code comments, that doesn't involve putting absolute link to the generated html?