Skip to content

Decide whether to have a flowchart at the top of recipe pages and how to unify them #59

Description

@bielsnohr

Currently, at the top of recipe pages (like 'Find a Review') we have a flowchart in a drop down like this:

{{< admonition type="example" title="Expand for flowchart" open=false >}}

{{< mermaid >}}
%% lonecoder mermaid
graph TD;
  Link(Links to more info)
  A([Start]) --> B(Meet initial requirements)
  YouAreHere(You are here)
  B --> C(Find a reviewer)
  C --> D(Meet and agree on objectives)
  D --> E(Explain scientific context)
  E --> F(Explain code structure)
  F --> G{Is code large?}
  G -- No --> H[Select up to 400 lines to work on]
  G -- Yes --> I[Split into smaller sections and agree on a series of reviews]

  click C "https://researchcodereviewcommunity.github.io/dev-review/recipes/find_a_reviewer/" "Find a reviewer"
  click D "https://researchcodereviewcommunity.github.io/dev-review/recipes/meet_and_agree_on_objectives/" "Meet and agree on objectives"
  click F "https://researchcodereviewcommunity.github.io/dev-review/recipes/explain_code_structure/" "Explain code structure"

  classDef default fill:#8EB6DE,stroke:#162D4D,stroke-width:2px,color:#162D4D;
  classDef linkedBox fill:#FABB00,stroke:#000,stroke-width:2px,color:#000;
  classDef youAreHereBox fill:#FA3800,stroke:#000,stroke-width:2px,color:#000;
  class Link,D,F linkedBox
  class YouAreHere,C youAreHereBox
{{< /mermaid >}}

{{< /admonition >}}

This is now out of date, which itself raises two questions:

  1. Do we want to have this flowchart here?
  2. If so, how do we maintain a 'central' flow chart that can be included in each of these pages so that we don't have to update them individually each time.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions