Fix broken links in docs

[elliotwaite]

I recently wrote a script to find all the broken links in the docs: https://github.com/elliotwaite/nim-broken-link-finder

And I create a PR to update most of the ones I found: https://github.com/nim-lang/Nim/pull/16336

However, there were some that I didn't know how to fix, so I'll explain them here.

---

These pages list imports that lead to 404 pages:

• https://nim-lang.github.io/Nim/io.html - broken import link: formatfloat
• https://nim-lang.github.io/Nim/asyncfutures.html - broken import link: stacktraces
• https://nim-lang.github.io/Nim/pathnorm.html - broken import link: osseps
• https://nim-lang.github.io/Nim/system.html - broken import links: ansi_c formatfloat memory stacktraces

---

These modules have broken links, but I couldn't find them in the repo to edit them. Do they still exist?

filepermissions broken links:

• https://nim-lang.github.io/Nim/filepermissions.html#getFilePermissions,string
• https://nim-lang.github.io/Nim/filepermissions.html#setFilePermissions,string,set[FilePermission]

btreetables broken links:

• https://nim-lang.github.io/Nim/btreetables.html#mget,CountTableRef[A],A
• https://nim-lang.github.io/Nim/btreetables.html#mget,CountTable[A],A
• https://nim-lang.github.io/Nim/btreetables.html#newTable,int
• https://nim-lang.github.io/Nim/btreetables.html#rightSize,Natural

---

These next ones are related to identifiers that are listed twice on the same page (e.g. Document and document).

For example, the dom module has this link target:

• https://nim-lang.github.io/Nim/dom.html#document_2

But when you click on the actual identifier link (the "document" link), it tries to navigate to a version of the URL without the "_2" suffix, which is a dead link:

• https://nim-lang.github.io/Nim/dom.html#document

The same thing happens for these other identifiers:

• https://nim-lang.github.io/Nim/dom.html#navigator_2
• https://nim-lang.github.io/Nim/dom.html#window_2
• https://nim-lang.github.io/Nim/jsconsole.html#console_2
• https://nim-lang.github.io/Nim/sexp.html#SexpError_2
• https://nim-lang.github.io/Nim/parsejson.html#JsonError_2

And that last one for JsonError also messes up the JsonError link near the bottom of the json module page in its Exports section.

---

The "mget proc" link listed here is broken, but I wasn't sure where it was supposed to link to.

---

The exitprocs page has two strange listings in the left menu that have a ")" and a ")_2" at the end of them:

• addExitProc,proc)
• addExitProc,proc)_2

In my PR, I fixed a link that points to one of them (the second change here), but maybe it should be changed back if those are being generated incorrectly.

---

On the random module's page, the two links in the left menu for the rand procs that take an HSlice parameter are broken:

• rand,Rand,HSlice[T: Ordinal or float or float32 or float64,T: Ordinal or float or float32 or float64]
• rand,HSlice[T: Ordinal or float or float32 or float64,T: Ordinal or float or float32 or float64]

---

Also, the index and the compiler index have a lot of broken links.

For example, the link under Ascending, for SortOrder.Ascending, points to:

• https://nim-lang.github.io/Nim/algorithm.html#Ascending

But it should actually point to:

• https://nim-lang.github.io/Nim/algorithm.html#SortOrder

I made some Gists that list all the broken links for each:

• Index broken links
• Compiler index broken links

[timotheecour]

The correct fix is to implement https://github.com/nim-lang/RFCs/issues/125 with obvious benefits:

• broken links would give CT errors when running nim doc
• links would be easier to read/write/edit
• each link would give rise to an entry in the index
• links wouldn't break when you change a proc to a func or add optional params
• there are easy ways to handle overloaded procs in the same module, I can describe what I have in mind