Split CB documentation to smaller pages

[vitvakatu]

Pull Request Description

Now documentation for types, constructors and methods is displayed separately, with a links between pages.
It drastically improves the speed of documentation panel update (50-100x on my machine), and also provides more readable documentation.

2023-05-31.00-55-50.mp4

Before:

After:

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

• The documentation has been updated, if necessary.
• Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
• All code follows the
  Scala,
  Java,
  and
  Rust
  style guides. In case you are using a language not listed above, follow the Rust style guide.
• All code has been tested:
  • Unit tests have been written where possible.
  • If GUI codebase was changed, the GUI was tested when built using ./run ide build.

[farmaazon]

It took me a while to realize the cleverness of this code.

I definitely needed some high-level explanation (and a warning) that creating documentation for an entry will also generate documentation for all entities in its module, allowing jumping over the module through links. The current documentation_ir module docs are outdated.

(I hope it was tested for huge modules, like Base.Data)

[vitvakatu]

I extended the documentation. We will generate module-level docs for every Method, Type or Constructor, not every type of entry (but pretty much for most of them). That's an unfortunate drawback, but it's hard to design the whole thing with links otherwise. One of the solutions is a documentation registry, but there are so much questions with cache invalidations there, that I don't even want to touch it.

As for testing, the new implementation actually does less work in some cases than the previous one, and the generation of IR was never an issue even on slow machines.

[wdanilo]

Just a fast review, as Adam did deep one :)

[wdanilo]

We could make it a lot shorter in many places by doing Documentation::ModuleMethod(&method, &module_docs) and define its parameters in the new fn as something: Into<...>, This way it will work both for references and passing owned values, making the usage way nicer.

[MichaelMauderer]

QA: 🍏 Looks good to me.

[radeusgd]

This is so awesome!

I'm just slightly surprised why we use the :: for delimiting the parent type and the method when displaying in CB: like Text::trim. We don't have such syntax anywhere in the language. Shouldn't we just use a . like Text.trim?

[vitvakatu]

I'm just slightly surprised why we use the :: for delimiting the parent type and the method when displaying in CB: like Text::trim. We don't have such syntax anywhere in the language. Shouldn't we just use a . like Text.trim?

Yep, this is in the list of things to be fixed in the next PR.