Documentation to do list¶
General¶
Todo
- Add back the MAP client section when the application is ready for testing.
- Update all screenshots to Windows 7 (Or OS-X, or latest Ubuntu, as appropriate).
- Change names of OpenCMISS and cmgui to OpenCMISS Iron and OpenCMISS Zinc.
- Finalise content for About ABI section; avoid overlap with ABI website but provide links.
- Populate CellML API section
- Add many more references (
.. _like-this:
) to docs for cross-referencing.
Within sections¶
Todo
- Add back the MAP client section when the application is ready for testing.
- Update all screenshots to Windows 7 (Or OS-X, or latest Ubuntu, as appropriate).
- Change names of OpenCMISS and cmgui to OpenCMISS Iron and OpenCMISS Zinc.
- Finalise content for About ABI section; avoid overlap with ABI website but provide links.
- Populate CellML API section
- Add many more references (
.. _like-this:
) to docs for cross-referencing.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/abibook/checkouts/latest/ABIBook-TODO.rst, line 10.)
Todo
- This entire section.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/abibook/checkouts/latest/MAP/index.rst, line 13.)
Todo
- Update all PMR documentation to reflect workspace ID changes and user workspace changes, if they go ahead.
- Get embedded workspaces doc written.
- Get some best practice docs written.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/abibook/checkouts/latest/PMR/index.rst, line 26.)
Todo
Add some useful command examples to command window doc - eg. "saving" graphics
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/abibook/checkouts/latest/cmgui/index.rst, line 34.)