Developer's Manual: Copyedit gui coding section #8733
Description
Issue Description
As a developer, I find that many of these pages are very outdated and had very verbose code fragments that no longer represent the best approaches (and not very easy to read). Rather than rewrite these code fragments as they are, it would be preferable to link to either external documentation or internal live examples instead.
Additional Information
This ticket was initially created from a PR, which was submitted for a flash review. It was considered that a flash review was not appropriate and a full review is necessary.
Acceptance Criteria
- The coding section of the manual is rationalised and readability improved.
- Useful information and procedures are not lost.
How to Review
- Pull the branch of the ibex_developers_manual that has the proposed changes.
- Build the documentation using:
sphinx-autobuild doc _build - Read the modifications in the 'coding' section and compare side-by-side with the existing documentation
- Consider the changes and highlight any areas that have been deleted, which may actually still be useful.
To the reviewer: Make sure to update submodules!