open-rmf / open-rmf/crossflow

Support config / substitutions in section templates

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
72
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Currently diagram section builders can take in a configuration struct to affect their behavior, but section templates are stuck with whatever settings they happen to be given.

It would be good if we can provide a way for section templates to substitute a portion of their inner contents with values that users specify per each instantiation of the template. That would effectively allow section templates to be configured, similar to section builders.

Ideally we should try to use an existing standard format for expressing variable substitutions in JSON.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Rust entry points for diagram section builders and section templates, then inspect how template instances receive configuration today. Research a standard JSON substitution format and trace any related tests or examples. Done means template instances can apply user-specified substitutions to their inner contents, with the behavior covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.