[doc] Documentations improvements tracker

[oowekyala]

• General
  • [doc] Generate docs for PMD 7 #1769
  • [core] Host own javadoc on docs.pmd-code.org #2417
  • [doc] Upgrade libraries (bootstrap, fontawesome, jquery, ...) #2795
• Layout / Styling
  • [doc] Add floating table-of-contents (toc) on the right #2502 (in PMD 6.43.0 already, via [doc] Add floating table of contents (issue #2502) #3804)
  • [doc] Improve "Edit me on github" button #2504 (in PMD 6.44.0 already, via [doc] Improve "Edit me on github" button #3811)
  • [doc] Improve side bar to show release date #2505 (in PMD 6.45.0 already, via [doc] Improve side bar by Adding Release Date #3883)
• Content
  • User Documentation
    • [docs] Update docs about writing rules #2267 (done in 6.22.0, XPath: Functions and Versions)
    • [doc] Provide documentation for gradle integration and plain java API integration #2283 (done in 6.22.0, Add gradle docu)
    • [doc] Document rule chain #597
    • [doc,java] Language specific documentation for java #2514

Remaining tasks

Probably for PMD 7

• User Documentation
  • [doc] Review guides for writing java/xpath rules for correctness with PMD 7 #2511
  • [doc] Migration Guide for upgrading PMD 6 ➡️ 7 #4294

Postponed for 7.x

• Layout, Styling
  • [doc] Integrate plantuml into doc generation #2503
• General Content
  • [doc] Improve Landing Page pmd.github.io #2506
  • [doc] Update Project Documentation #4292
  • [doc] Short project history #4293
• User Documentation
  • [doc] Improve documentation for Suppression #893
  • [doc] Improve our index for newcomers #2507
  • [doc] Create a Getting started series to replace the getting-started panel #2508
  • [doc] Create/rework FAQ page #2509
  • [doc] Rework rule guidelines #2510
  • [doc] Review documentation for features and usage of the designer for correctness with PMD 7 #2512
  • [doc] Merge CI integrations into Other tools / integrations #2513
• Developer Documentation
  • [doc] Promote wiki pages to standard doc pages #2492
  • [doc] Further (java)doc improvements #2433
  • [doc] Update the Writing Documentation page itself #2515
  • [doc] Using the benchmarking feature of PMD #2516
  • [doc] Provide a high-level overview of PMD's building blocks #2517
  • [doc] Provide step-by-step guides to enhance PMD #906
• Rule Reference
  • [doc] Generate a complete rule catalog in a machine-readable format #4295
  • [doc] Create a simple online Ruleset Editor #4296
  • [doc] Produce example configs for rule properties #4297
  • [doc] Improve rule index #4298
  • [doc] Provide use-case based default rulesets #4299

[adangel]

Closing this tracking issue as done. The remaining tasks are either tracked by #3898 or are postponed.