search

tetrabiodistributed / tetra

Documentation repository for Project Tetra
https://tetrabiodistributed.github.io/tetra
MIT License
7 stars 7 forks source link

Concerns about images being used #91

Open darraghbr opened 3 years ago

darraghbr commented 3 years ago

The concern I have with using the dynamically generated images is that it is challenging to link to other areas in the docs.

For instance on the stakeholders concerns and requirements, ideally we would be able to click on a requirement ID and see everywhere that requirement ID is referenced across any docs, test specs results etc.

I think a better approach is to just use tables as set out in the Helpful Engineering templates.

capsulecorplab commented 3 years ago

@darraghbr thanks for the concern. It's worth noting that both a diagram and a table are merely views of the content, not the content itself. That being said, plantuml, which is the underlying plaintext modeling language we're using to construct these views, does support embedded links, and asciidoc supports tables. I'm currently investigating a workflow for being able to parse and embedd plantuml elements into asciidoc, using liquidocs, so you'll likely see this use case accommodated for soon.