docs: module links go to the module docs; writing rules in the README

Yunshuang Yuanrequested to merge
docs/links-to-module-docs into main

Part of #4 (closed) (issue stays open until checked).

  • plesty-fss, plesty-pol-pl and the demo experiment links now open docs.plesty.net/<module>/ instead of the GitLab repositories (all three publish docs).
  • README: new Writing rules section — plain wording, one name per thing, module links to docs, no dead links.

Link check of a local build (48 pages): no dead internal links in this repo. Still open:

  • gitlab.com/plesty/demo-bench (Build & Run an Experiment) does not exist on gitlab.com; the page tells readers to clone it. Needs the repository published, or the setup rewritten.
  • The Download page links learn/architecture/bench.html, which does not exist; that page comes from the site generator and is fixed there with #3 (closed).
  • Not verifiable while the hosts are down: every docs.plesty.net, hub.plesty.net and community.plesty.net link. The plesty-bench pages linked exist on its docs-build branch.
  • The module docs pages do not link their repository yet (only plesty-fss shows a clone URL) — a docs-template change in plesty-sdk, not here.

Merge request reports