Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to related tutorials #285

Open
jobara opened this issue Jul 31, 2024 · 1 comment
Open

Add links to related tutorials #285

jobara opened this issue Jul 31, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@jobara
Copy link
Member

jobara commented Jul 31, 2024

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 jobara added the enhancement New feature or request label Jul 31, 2024
@jobara
Copy link
Member Author

jobara commented Jul 31, 2024

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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant