Developer/User Documentation

[WolframPfeifer]

Our documentation page at https://keyproject.github.io/key-docs/ is very sparse, not very visible, and partly outdated. Apart from that, the page is in a bad shape (some dead links, 404, empty pages, ...).

Ideas

Some random ideas what could be done:

• make the existing website more visible from the KeY GUI somehow
• repair the links and menu
• select important "features" to document
  • testing infrastructure: Which kinds of tests do we have (Java code, .key files, closed proofs, unit tests, ...)? Where to put them?
• create a page "How to Start with KeY Development"
• add a "documentation" pane for KeY which renders the docs in KeY (probably it is preferable to better use a normal browser instead)
• ...

[wadoon]

add a "documentation" pane for KeY which renders the docs in KeY (probably it is preferable to better use a normal browser instead)

HTML rendering is terrible in Swing. IntelliJ solves this using an self-baked JRE with the chrome-embedding framework. The other option would be a switch to JavaFX. Both are infeasible.

Back in the glory swing days, there was a project flyingsaucer.