apify-docs icon indicating copy to clipboard operation
apify-docs copied to clipboard

Use tags to organize Glossary and Tutorials

Open honzajavorek opened this issue 1 year ago • 2 comments

I did a proof of concept and the good news is that Docusaurus tags are easy to use:

Screenshot 2024-07-23 at 7 54 35 Screenshot 2024-07-23 at 7 54 45

Screenshot 2024-07-23 at 07-55-02 One doc tagged with Concepts Apify Documentation

The bad news is that if we want anything else, like listing relevant tags and their pages on the glossary or tutorials homepage, it requires quite some amount of engineering:

  • https://github.com/facebook/docusaurus/discussions/8931#discussioncomment-5733890
  • https://github.com/facebook/docusaurus/issues/8886#issuecomment-1506719062
  • https://stackoverflow.com/q/75534084/325365

honzajavorek avatar Jul 23 '24 06:07 honzajavorek

Moving from internal chat:

@TC-MO: So the question would be if default behaviour is enough. If not whether all the work spent on custom setup is worth it over default behaviour ?

The default behavior is nice, but I see these problems:

  • I'd like to use the tags at both glossary and tutorials. But I don't want to mix those two, I still want them in separate sections (how-to guides and explanations, according to Diátaxis). That is no problem as we could just use different tags in both.
  • Then both glossary and tutorials need something like landing page, where I'd like to have something like an overview of what tags (relevant just to glossary or tutorials) are available and what articles are inside.
  • If we have that, I'd remove the categories and the whole left panel altogether from glossary and tutorials. The tags would be the main means of navigation for those two top-down, and breadcrumbs would navigate users bottom-up. I don't think the left panel is useful for users as they either come to these sections of the website by a link or search. Nobody is going to browse these like a book, from start to end.

This would be my idea, but given how hard can be to set up the landing page, it's definitely good to ask whether it's worth it.

honzajavorek avatar Jul 23 '24 06:07 honzajavorek

Maybe there's a way to use the built-in system in a way that it fits what I have in mind? E.g. we could tag all pages in tutorials by their topics, but also by „Tutorials“ and everything in Glossary as „Glossary“. Then these two would have listing pages.

Those wouldn't be the best landing pages in the world, but as a compromise maybe we could link them from the menu… But then still, there's zero built-in customization of the text on that particular tag listing page, and so on.

honzajavorek avatar Jul 23 '24 06:07 honzajavorek