To-do list¶
Finally, if you are looking for a way to contribute, helping with the documentation would be great. A list of incomplete documentation (or incomplete features) is below. You can also look on the SMTK issue tracker for things to do.
Todo
Expand on details of installation and configuration.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/administration.rst, line 27.)
Todo
Expand on details of installation and configuration.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/administration.rst, line 41.)
Todo
Describe attributes and how they are serialized
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/attribute/file-syntax.rst, line 1651.)
Todo
Describe <ItemsViews> children
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/attribute/file-syntax.rst, line 2032.)
Todo
Explain how to make this robust against re-runs of the script that generates bindings.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/bindings/customizing-pybind11-bindings.rst, line 38.)
Todo
Create runtime-configurable classes (ProgrammableResource, ProgrammableNode, ProgrammableArc) that can be Python-wrapped and configured via a JSON serialization.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/graph/concepts.rst, line 80.)
Todo
Add a section domain types, especially IdSpace for discrete geometry.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/markup/concepts.rst, line 145.)
Todo
Describe SMTK’s auto-init macros.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/model/operators.rst, line 16.)
Todo
Describe what blocks and sets are
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/model/session-exodus.rst, line 10.)
Todo
Describe how blocks and sets are mapped to models and groups
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/model/session-exodus.rst, line 11.)
Todo
Show simple example?
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/model/session-exodus.rst, line 12.)
Todo
Update how modeling sessions are exposed via plugins.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/model/sessions.rst, line 53.)
Todo
Discuss Remus and ParaView client/server sessions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/model/sessions.rst, line 58.)
Todo
Describe the base phrase model class
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/view/phrases.rst, line 43.)
Todo
Describe the base phrase content class and its children
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/view/phrases.rst, line 74.)
Todo
Describe the base subphrase generator class and its children
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/doc/userguide/view/phrases.rst, line 79.)