From bd8de9aa6290ca9b1cdb144d861ef1493d24b2d0 Mon Sep 17 00:00:00 2001 From: thomas-bc <49786685+thomas-bc@users.noreply.github.com> Date: Fri, 6 Dec 2024 13:57:45 -0800 Subject: [PATCH 1/2] Clean up getting started documentation --- docs/getting-started/index.md | 15 +++++++-------- docs/getting-started/projects.md | 17 ----------------- docs/mkdocs.yml | 4 +--- 3 files changed, 8 insertions(+), 28 deletions(-) delete mode 100644 docs/getting-started/projects.md diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 605230a419..615c4bff8a 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -1,6 +1,5 @@ -# F´ A Flight Software and Embedded Systems Framework +# Getting Started with F Prime -## Overview F´ (F Prime) is a component-driven framework that enables rapid development and deployment of spaceflight and other embedded software applications. Originally developed at the Jet Propulsion Laboratory, F´ has been successfully deployed on several space applications. It is tailored but not limited to small-scale spaceflight systems such as CubeSats, SmallSats, and instruments. F´ has the following features: @@ -11,13 +10,13 @@ F´ has the following features: - A standard library of flight-worthy components - Testing tools for unit and system-level testing -## F´ External Resources -- [GitHub Repository](https://github.com/nasa/fprime) -- [Discussions](https://github.com/nasa/fprime/discussions) -- [Issues](https://github.com/nasa/fprime/issues) -- [Community GitHub Organization](https://github.com/fprime-community) +## Hello, World! + +New users should start with the [Hello World tutorial](../tutorials-hello-world/docs/hello-world//). This tutorial walks through the F´ installation process, how to create a new project and how to design, implement, and test a basic F Prime application. ## Further References -To start with F´, follow the [installation guide](installing-fprime.md). Then follow our [tutorials](../documentation/tutorials/index.md), or inspect our [reference applications](https://github.com/fprime-community#references). \ No newline at end of file +Here are some additional references to continue learning about F´: +- [More tutorials]((../documentation/tutorials/)) +- [F´ User Manual](../documentation/user-manual/) diff --git a/docs/getting-started/projects.md b/docs/getting-started/projects.md deleted file mode 100644 index d36bfe91a5..0000000000 --- a/docs/getting-started/projects.md +++ /dev/null @@ -1,17 +0,0 @@ -# F´ Projects - -View F Prime Projects showcase here: [Projects](../overview/projects.md) - -Here are the projects and programs identified applying the F´ code: - - -|**_Project/Program_**| **_Type_** | **_NASA Center / Company_** | **_OS_** | **_HW Platform_** | **_Launch Date_**| **_End of Mission_** | **_Note_**| -|:---|:---|:---|:---|:---|:---|:---|:---| -| [ISS-RapidScat (International Space Station Rapid Scatterometer)](https://www.jpl.nasa.gov/missions/international-space-station-rapid-scatterometer-iss-rapidscat) | Instrument | [NASA's JPL](https://www.jpl.nasa.gov/) | | | Sep. 21, 2014 | Nov. 18, 2018 | Target: Earth | -| [ASTERIA (Arcsecond Space Telescope Enabling Research in Astrophysics)](https://www.jpl.nasa.gov/missions/arcsecond-space-telescope-enabling-research-in-astrophysics-asteria) | Technology Demonstration, CubeSat/SmallSat | [NASA's JPL](https://www.jpl.nasa.gov/) | Linux | PowerPC | Aug. 14, 2017 | End of Feb. 2020 | [Publication](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=4067&context=smallsat) - Target: Exoplanets | -| [Mars Helicopter (Ingenuity)](https://mars.nasa.gov/technology/helicopter/) | Airborne | [NASA's JPL](https://www.jpl.nasa.gov/) | Linux | Qualcomm’s Snapdragon 801 | Jul. 30, 2020 | Ongoing | Target: Mars | -| [Lunar Flashlight CubeSat](https://www.jpl.nasa.gov/missions/lunar-flashlight) | Technology Demonstration, CubeSat/SmallSat | [NASA's JPL](https://www.jpl.nasa.gov/) | VxWorks | Sphinx (GR712 - LEON3FT SPARC) | Dec. 11, 2022 |Ongoing | [Publication](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=5263&context=smallsat) - Target: Moon | -| [Near Earth Asteroid Scout CubeSat](https://www.jpl.nasa.gov/missions/near-earth-asteroid-scout-neascout) | Technology Demonstration, CubeSat/SmallSat | [NASA's JPL](https://www.jpl.nasa.gov/) | VxWorks | Sphinx (GR712 - LEON3FT SPARC) | Nov. 16, 2022 | Ongoing | [Publication](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=5263&context=smallsat) - Target: Asteroids and Comets | -| [OWLS (Ocean Worlds Life Surveyor instrument)](https://www.jpl.nasa.gov/go/owls) | Instrument | [NASA's JPL](https://www.jpl.nasa.gov/) | | | | | | -| [CADRE (Cooperative Autonomous Distributed Robotic Explorers)](https://www.nasa.gov/directorates/spacetech/game_changing_development/projects/CADRE) | Robot | [NASA's JPL](https://www.jpl.nasa.gov/) | | | | | | -| [COLDArm (Cold Operable Lunar Deployable Arm)](https://www.nasa.gov/feature/cold-operable-lunar-deployable-arm-coldarm/) | Robotic arm | [NASA's JPL](https://www.jpl.nasa.gov/) | | | | | | \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7121aefe9b..d12b5b3d0e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -271,9 +271,7 @@ nav: - 'F´ Projects': overview/projects.md - Getting Started: - getting-started/index.md - - 'Installing F´': getting-started/installing-fprime.md - - 'F´ Features': getting-started/features.md - - 'F´ Projects': getting-started/projects.md + - 'Installation and Troubleshooting': getting-started/installing-fprime.md - Documentation: - documentation/index.md - Tutorials: From 5f0807987d9537499419c39eefd2bc725a328276 Mon Sep 17 00:00:00 2001 From: thomas-bc <49786685+thomas-bc@users.noreply.github.com> Date: Fri, 6 Dec 2024 14:03:29 -0800 Subject: [PATCH 2/2] Fix link typo --- docs/getting-started/index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 615c4bff8a..488ca697f8 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -1,3 +1,8 @@ +--- +hide: + - toc +--- + # Getting Started with F Prime F´ (F Prime) is a component-driven framework that enables rapid development and deployment of spaceflight and other embedded software applications. Originally developed at the Jet Propulsion Laboratory, F´ has been successfully deployed on several space applications. It is tailored but not limited to small-scale spaceflight systems such as CubeSats, SmallSats, and instruments. @@ -18,5 +23,5 @@ New users should start with the [Hello World tutorial](../tutorials-hello-world/ ## Further References Here are some additional references to continue learning about F´: -- [More tutorials]((../documentation/tutorials/)) +- [More tutorials](../documentation/tutorials/) - [F´ User Manual](../documentation/user-manual/)