Skip to content
New issue

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

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

Already on GitHub? # to your account

Ensure that all section headers are generic and not target specific #238

Open
erlingrj opened this issue Feb 25, 2024 · 3 comments
Open

Comments

@erlingrj
Copy link
Collaborator

erlingrj commented Feb 25, 2024

For instance under the Tracing page:
image

The sections "Tracing in C++" and "Usage" does not exist for the C target. Clicking those links will not make anything happen. It makes it hard to get an overview for articles with multiple target languages.

@axmmisaka
Copy link
Collaborator

I believe this would require us to contribute upstream - facebook/docusaurus#6201 (comment)

@slorber
Copy link

slorber commented May 10, 2024

For reference, here's the page link:
https://www.lf-lang.org/docs/reference/tracing/

What I understand is that you want to put headings inside tabs, and expect the TOC items to self-update on tab change.

This is discussed in another issue and would be quite complex to build correctly:
facebook/docusaurus#5343

@lhstrh
Copy link
Member

lhstrh commented May 11, 2024

@slorber: thanks for taking a look at this. Yes, what you're describing is the feature we'd like to have. Lingua Franca has different targets, and there is no full feature parity between targets, so there are some headings that exist under one tab, it might not exist under another.

@erlingrj: since self-updating toc items are currently not supported, a near term fix would be to structure the content under the different tabs such that the headers are generic (i.e., have a header called "Enabling Tracing" and have target-specific instructions under it). For the time being, if a feature isn't supported, we could just have a "Not supported" message in the content. TL;DR: We shouldn't have target-specific headers like "Tracing in C++" and "Tracing in C and Python" if we are already using tabs.

@cmnrd cmnrd added this to the website cleanup milestone Jul 9, 2024
@cmnrd cmnrd changed the title The "section-view" on the right side is not updated when switching between targets Ensure that all section headers are generic and not target specific Jul 9, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants