Skip to content

Add related links #563

Description

@max-rosin

Add related topics where appropriate.
Related links are added in a Related links section as an unordered list of links reproducing the heading of the target topic

Adding a related link is appropriate if it fulfills one or more of the following criteria:

  • The target topic is explicitely mentioned in the source topic.
  • The target topic describes a prerequisite of the source topic.
  • The target topic describes a regular next step that is almost always carried out afterwards.
  • The target topic contains information immediately relevant to understanding the topic (Example: The source topic describing how to change a format should link to a target topic describing the different formats.)

Example:

  • Source: doc/architecture/formatting_scripts.adoc
  • Target: doc/architecture/trace_file_formats.adoc

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

DocumentationEverything which impacts the quality of the documentation and guidelines.

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions