search

nasa / fprime

F´ - A flight software and embedded systems framework
https://fprime.jpl.nasa.gov
Apache License 2.0
10.02k stars 1.29k forks source link

Google Search Shows Old Versions #2573

Open csmith608 opened 5 months ago

csmith608 commented 5 months ago
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.

thomas-bc commented 5 months ago

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!

LeStarch commented 5 months ago

We should stamp old versions with a tag saying:

"Latest documentation available here: link to devel"

LeStarch commented 5 months ago

One more to look into after the webwork!