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 table of contents to application manifest reference #1192

Open
michelleN opened this issue Feb 23, 2024 · 6 comments
Open

add table of contents to application manifest reference #1192

michelleN opened this issue Feb 23, 2024 · 6 comments
Assignees
Labels

Comments

@michelleN
Copy link
Member

The manifest reference has a lot of great content. A table of contents would help me more easily search for the thing I'm looking for. https://developer.fermyon.com/spin/v2/manifest-reference

@michelleN michelleN changed the title add table of contents add table of contents to application manifest reference Feb 23, 2024
@tpmccallum
Copy link
Contributor

tpmccallum commented Feb 26, 2024

Hi @michelleN
The manifest reference (and all other pages) have a Table of Contents (ToC) in place.
However, the rendering cuts out the table of contents below a specific screen size.
This is a great catch, @michelleN - we need to ensure that the page's ToC is visible from 1024 x 1366 and above (i.e. iPad Pro), not just on Desktop dimensions.

Please see the screen captures (browser and code sample) below which shows how the ToC is actually formed (the ToC follows the page's heading layout/hierarchy).

Screenshot 2024-02-26 at 13 48 44
Screenshot 2024-02-26 at 13 48 30

@karthik2804
Copy link
Contributor

It might be the case of smaller screen widths not displaying the ToC.

@tpmccallum
Copy link
Contributor

Fair enough @karthik2804
@michelleN are we ok to close this one?
If you would like to render the ToC on your screen size please let us know the dimensions and I will see if we can tweak the cutoff point for ToC rendering on smaller screens.

@tpmccallum
Copy link
Contributor

We must ensure that the right hand side ToC (that shows the sections/headings of the page where it is displayed) works on smaller screens; MacBook laptops at a minimum (perhaps larger tablets also).

@tpmccallum tpmccallum self-assigned this Jun 29, 2024
@tpmccallum
Copy link
Contributor

@flynnduism Can you and I collaborate on a fix for this please?
We can fix not before the v3_ToC work is finalized and it will just automatically come across to the new site (because of the way we have designed the v3_ToC migration scripts).

@tpmccallum
Copy link
Contributor

I did some research on similar documentation sites and it appears that the right-hand-side page-specific ToC should render to as low as (and including 1024 x 1366) which is the iPad Pro dimensions.

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

No branches or pull requests

3 participants