EOEPCA / system-architecture

EOEPCA System Architecture document
Apache License 2.0
3 stars 1 forks source link

Add references to other building blocks to top nav #6

Open j08lue opened 1 week ago

j08lue commented 1 week ago

Goal: All building block docs pages are featured in the top nav like in this example.

image
rconway commented 1 week ago

Hi @j08lue . My only concern is that this approach will not scale across the screen with too many building blocks. Do you think it will work?

j08lue commented 5 days ago

My only concern is that this approach will not scale across the screen with too many building blocks. Do you think it will work?

Right, no, this will probably not work for the full set. We could start with this, though, and refactor later? Quick cross-references across BBs is quite nice, though, IMO.

rconway commented 5 days ago

Yes - I would really like a good solution for this - ideally an html snippet or similar that could be included in the header for each doc, to provide a consistent look. Any ideas?

jonas-eberle commented 5 days ago

Yes - I would really like a good solution for this - ideally an html snippet or similar that could be included in the header for each doc, to provide a consistent look. Any ideas?

Maybe a drop-down menu? So you could have "Building Blocks" as a main item beside System Architecture with a drop down of all building blocks?

rconway commented 5 days ago

Maybe a drop-down menu? So you could have "Building Blocks" as a main item beside System Architecture with a drop down of all building blocks?

Is there a mechanism to add custom snippets with RtD and/or mkdocs?