Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add references to other building blocks to top nav #6

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

j08lue
Copy link

@j08lue j08lue commented Jun 25, 2024

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

image

@rconway
Copy link
Contributor

rconway commented Jun 25, 2024

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
Copy link
Author

j08lue commented Jun 28, 2024

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
Copy link
Contributor

rconway commented Jun 28, 2024

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
Copy link

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
Copy link
Contributor

rconway commented Jun 28, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants