Metadata
- Source
- FLUID-5707
- Type
- Improvement
- Priority
- Critical
- Status
- Closed
- Resolution
- Migrated
- Assignee
- Jonathan Hung
- Reporter
- Anastasia Cheetham
- Created
2015-07-14T11:13:51.018-0400 - Updated
2024-07-31T16:10:40.282-0400 - Versions
- N/A
- Fixed Versions
- N/A
- Component
-
- Tech. Documentation
Description
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.
Comments
-
Anastasia Cheetham commented
2015-07-14T11:17:49.518-0400 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...
-
Justin Obara commented
2024-07-31T16:09:37.850-0400 Migrated to https://github.com/fluid-project/infusion-docs/issues/285