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.

Sign up for GitHub

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

Clean up getting started guide #3061

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Clean up getting started guide #3061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd8de9a
Clean up getting started documentation
thomas-bc Dec 6, 2024
5f08079
Fix link typo
thomas-bc Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# F´ A Flight Software and Embedded Systems Framework
---
hide:
- toc
---

# 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:
Expand All @@ -11,13 +15,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).
Here are some additional references to continue learning about F´:
- [More tutorials](../documentation/tutorials/)
- [F´ User Manual](../documentation/user-manual/)
17 changes: 0 additions & 17 deletions docs/getting-started/projects.md
View file
Open in desktop

This file was deleted.

4 changes: 1 addition & 3 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading