fprime icon indicating copy to clipboard operation
fprime copied to clipboard

Google Search Shows Old Versions

Open csmith608 opened this issue 11 months ago • 3 comments

F´ Version 3.4.3
Affected Component Documentation


Feature Description

Add a theme to outdated fprime documentation indicating that it is outdated and has been superseded by a newer version.

Rationale

To quickly find a part of an fprime tutorial to reference I'll use Google to search. For example, I'll Google "math component fprime" and the first hit is the tutorial from fprime 2.0.0. The second hit is from fprime 3.1.0. Adding a header would reduce confusion and is standard in some other repositories.

csmith608 avatar Mar 07 '24 00:03 csmith608

Changes probably need to be done in that branch here if what is requested is for the older versions of documentation: https://github.com/nasa/fprime/tree/docs/auto-documentation/docs

Not too sure what the best approach is to handle those kind of things - if anyone from the community wants to jump in and contribute for this, would be greatly appreciated!

thomas-bc avatar Mar 11 '24 18:03 thomas-bc

We should stamp old versions with a tag saying:

"Latest documentation available here: link to devel"

LeStarch avatar Mar 12 '24 00:03 LeStarch

One more to look into after the webwork!

LeStarch avatar Apr 01 '24 19:04 LeStarch