search

fluid-project / infusion-docs

Documentation space for Infusion
http://docs.fluidproject.org/infusion
Creative Commons Attribution 4.0 International
8 stars 45 forks source link

Add links to related tutorials #285

Open jobara opened 1 month ago

jobara commented 1 month ago

We should add to any relevant documentation page links to related tutorials, in some form of "See also" or "Related" section, or something.

Recently, a partner was trying to add UIO to a website and turned to the documentation for help. We have a tutorial, but the partner found the more complicated, less helpful documentation at http://docs.fluidproject.org/infusion/development/PreferencesEditor.html, and there is nothing there referencing the tutorial.

I think we should design an appropriate look/layout for "related links" and use that to add these kinds of internal links as much as possible. Especially given the lack of search, these links will make the docs much more useful.

Additional context or notes

Originally filed as FLUID-5707 by @acheetham on July 14, 2015.

jobara commented 1 month ago

Comment Migrated from FLUID-5707 originally posted by @acheetham on July 14, 2015

This might be too fancy, but it might be nice to have this generated i.e. add the references to related pages to the metadata, and have the HTML generated from that. It's possible this might make maintenance easier? Or not...