“See Also” Type of Relation

“Depends On” is the most basic relation in the system; it solves the problem of maintainability a lot. “Depends On” relations are directed, and they must not build up cycles. (Or a training will possibly last infinitely.)

Another type of relation is “See Also”. It is used to navigate through the material, having no particular target in mind. “See Also” is also directed, but it may introduce cycles - just as hyperlinks on The Web can.

Tasks:

  • Add new parameter see-also to jf-topic directive.

  • Differentiate “Depends On” and “See Also” types of edges using NetworkX edge attributes.

  • Modify existing code that currently treats any edge as “Depends On”.

  • Add “See Also” links as a sidebar to topics.

cluster_topic Project Plan cluster_topic_basics Basics topic_basics_see_also “See Also” Type of Relation 0.0% done initial 8.0h spent 0.0h topic_basics_basic_dependencies Basic Dependency Machinery 100.0% done initial 24.0h spent 24.0h topic_basics_see_also->topic_basics_basic_dependencies topic_basics_python_testset Python Training: Test Set of Topics 100.0% done initial 5.0h spent 0.0h topic_basics_see_also->topic_basics_python_testset topic_basics_python_testset->topic_basics_basic_dependencies