docs: Refactor docs directory hierarchy

[rodrigogiraoserrao]

Split docs folder into two subfolders.

All the main documentation content lives in docs/source.
Dynamically generated content lives in docs/assets.
This split prevents the MkDocs live reloading from entering an infinite loop when generating data files, images, or pages, for the documentation while it's being served with mkdocs serve.

[rodrigogiraoserrao]

I'm not necessarily a huge fan of the names docs/docs and docs/docs-res but nothing better came to mind.
I'm open to other suggestions.

EDIT: this has been solved with the help of orlp.

[orlp]

Does this PR affect the generated paths of the output (breaking existing links), or only the organization in the source tree?

As for naming suggestions, may I suggest docs/text and docs/assets?

[rodrigogiraoserrao]

Does this PR affect the generated paths of the output (breaking existing links), or only the organization in the source tree?

I don't understand the question.
Things have been moved around but the internal paths / links have been updated so everything still knows where everything is.

As for naming suggestions, may I suggest docs/text and docs/assets?

I like docs/assets; I don't love docs/text because I have things like the _build and src directories that contain scripts, snippets of code, and other assorted stuff.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.85%. Comparing base (b7e5e09) to head (6a2b4bc).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #18773   +/-   ##
=======================================
  Coverage   79.85%   79.85%           
=======================================
  Files        1518     1518           
  Lines      205637   205637           
  Branches     2893     2893           
=======================================
  Hits       164205   164205           
  Misses      40884    40884           
  Partials      548      548           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[orlp]

@rodrigogiraoserrao docs/source and docs/assets is fine by me.

[rodrigogiraoserrao]

The link analyser is complaining about a link that is indeed working... 🤷