Skip to content

"See also" links are not automatically generated for reference pages in sub-subcategories #487

Open
@per1234

Description

@per1234

Normally, links are automatically added to the "See also" section for all other pages in the same subcategory. However, this is not being done for the Serial, Stream, Keyboard, and Mouse function reference pages. Those only have links to the other pages in their subcategory when those links have been manually added.

I originally thought this was related to those pages being an extra subcategory down, but now I see that the automatically generated "See also" links work fine for the String reference pages.

Reference:

// for language tag, items will be automatically generated for any other item of the same subcategory,

Activity

kengdahl

kengdahl commented on Aug 27, 2020

@kengdahl
Member

It is done for:

  • Stream
  • Keyboard
  • Mouse

But still not for:

  • Stream

Whys is this?

per1234

per1234 commented on Aug 27, 2020

@per1234
CollaboratorAuthor

It is done for:

  • Stream

...

But still not for:

  • Stream

Huh? Did you make a typo?

@kengdahl this feature has been completely broken ever since the reworking of the Language Reference website generation system: https://github.com/bcmi-labs/reference/issues/119 (FYI to normal users: this is a private repo, so you getting a 404 is expected).

Any "See Also" links you see now on the website are there because they were manually added to the .adoc files. Manual "See also" links were added for either of two reasons:

  • Relevant content outside the category of the page (and thus not automatically generated)
  • Relevant content inside the category of the page for the few pages where the automatic "See also" link generation system was mysteriously broken (back in the good old days when it worked at all)
kengdahl

kengdahl commented on Aug 28, 2020

@kengdahl
Member

Yes. sorry. Typo. Stream is missing See also.

I'll see if I can add the See also manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      "See also" links are not automatically generated for reference pages in sub-subcategories · Issue #487 · arduino/reference-en