reference-en icon indicating copy to clipboard operation
reference-en copied to clipboard

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

Open per1234 opened this issue 6 years ago • 3 comments

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: https://github.com/arduino/reference-en/blob/87a3a6763645125f00ad649d803a6d84f0a8e549/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc#L120

per1234 avatar Jan 24 '19 07:01 per1234

It is done for:

  • Stream
  • Keyboard
  • Mouse

But still not for:

  • Stream

Whys is this?

kengdahl avatar Aug 27 '20 16:08 kengdahl

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)

per1234 avatar Aug 27 '20 18:08 per1234

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

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

kengdahl avatar Aug 28 '20 10:08 kengdahl