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

Restructure docs for new website #3036

Merged
merged 53 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
cb454c7
Create test.md
ashleynilo Aug 29, 2024
b17a900
Reconfigured IA, updated docs
ashleynilo Sep 5, 2024
0c12161
Added descriptions for custom pages
ashleynilo Sep 5, 2024
92e0a2a
Removed archive
ashleynilo Sep 5, 2024
ea19d8a
Add project page, update tutorials/user manual
ashleynilo Sep 18, 2024
2d4f27e
Removed tutorials images
ashleynilo Sep 19, 2024
fff99a2
Updated high level pages, renamed how-to
ashleynilo Sep 24, 2024
e52f71a
Update all overview pages
ashleynilo Oct 1, 2024
05083c2
New pages, updated user manual
ashleynilo Oct 3, 2024
f5516eb
Removed c++ and cmake files
ashleynilo Oct 3, 2024
dbf9851
Update tutorials overview text
ashleynilo Oct 7, 2024
7b50015
Updated links in markdown files with custom templates
ashleynilo Oct 31, 2024
905fde8
Updated descriptions/headings
ashleynilo Nov 4, 2024
0743a16
Update doxyfile for new structure + fix img links
thomas-bc Nov 12, 2024
f451633
Merge branch 'devel' into docs/new-website
thomas-bc Nov 12, 2024
11b256b
Fix spelling and CMake API links
thomas-bc Nov 12, 2024
65a2be4
Fix more links
thomas-bc Nov 18, 2024
c0160ad
Fix spelling
thomas-bc Nov 21, 2024
9cf4f8e
Merge remote-tracking branch 'nasa/devel' into docs/new-website
thomas-bc Nov 21, 2024
675e57e
Remove old ArmLinuxTutorial
thomas-bc Nov 21, 2024
323e650
Fix note for testing
thomas-bc Nov 21, 2024
cf03e60
Rename GDS doc file
thomas-bc Nov 21, 2024
30ddd22
Remove getting started TOC
thomas-bc Nov 22, 2024
c41fdc9
Update F' (quote) to F´
thomas-bc Nov 22, 2024
d3cf9b2
Initial github callouts test
ashleynilo Nov 23, 2024
4d622bf
Move mkdocs.yml to fprime repo
thomas-bc Nov 26, 2024
1f5b4b4
Fix button link for events page and deactivate autodocs.yml
thomas-bc Nov 26, 2024
0ddb27d
Update with github callouts
ashleynilo Nov 26, 2024
7e2946e
Merge remote-tracking branch 'nasa/devel' into docs/new-website
thomas-bc Nov 26, 2024
5da104b
Merge remote-tracking branch 'origin/docs/new-website' into docs/new-…
thomas-bc Nov 26, 2024
825b19e
Fix spelling and a few links
thomas-bc Nov 26, 2024
0afb872
Use symlink alias
thomas-bc Nov 26, 2024
2cef370
Use copy alias_type since gh-pages does not support symlink
thomas-bc Nov 26, 2024
ea547cb
Remove Architecture dir from docs
thomas-bc Nov 26, 2024
0822e7d
Rename api/c++ to api/cpp for URL correctness
thomas-bc Nov 26, 2024
0d36f0b
Remove GH Pages underscore handling (since nojekyll)
thomas-bc Nov 26, 2024
33d2a34
Remove autocomplete guide
thomas-bc Dec 2, 2024
745c76e
Remove versioned Doxygen and gh_pages.py
thomas-bc Dec 4, 2024
7580560
Fix more dead links
thomas-bc Dec 6, 2024
5ef1576
Update markdown-link-check to build docs
thomas-bc Dec 6, 2024
fa77c06
Install doxygen
thomas-bc Dec 6, 2024
bbf1cb0
Fix CMake files cross-reference links
thomas-bc Dec 6, 2024
d30a516
Markdown link check fixes
thomas-bc Dec 6, 2024
9d7728b
Add 1 new event
ashleynilo Dec 6, 2024
49263b8
last fix??
thomas-bc Dec 6, 2024
401e426
typo
thomas-bc Dec 6, 2024
a3de508
Merge remote-tracking branch 'ashley/patch-1' into docs/new-website
thomas-bc Dec 6, 2024
88cf999
mkdocs.yml update
thomas-bc Dec 6, 2024
d0963c0
Merge latest devel
thomas-bc Dec 6, 2024
e454ca2
Remove unused entrypoint.sh
thomas-bc Dec 6, 2024
7bedd73
Update Arduino tutorial link and cleanup titles
thomas-bc Dec 6, 2024
390af45
OCD
thomas-bc Dec 6, 2024
3f67526
Force Doxygen to light mode and add INSTALL.md back
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
12 changes: 0 additions & 12 deletions .github/actions/entrypoint.sh

This file was deleted.

9 changes: 1 addition & 8 deletions .github/actions/markdown-check/mlc-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,9 @@
},
{
"pattern": "https?://"
}
],
"replacementPatterns": [
{
"pattern": "^[./]*api/cmake/",
"replacement": "https://nasa.github.io/fprime/UsersGuide/api/cmake/"
},
{
"pattern": "^[./]*api/c\\+\\+/",
"replacement": "https://nasa.github.io/fprime/UsersGuide/api/c++/"
"pattern": "./tutorials-"
}
]
}
1 change: 1 addition & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,4 @@ ignore$
^docs/doxygen/mainpage.md$
^\Qcmake/test/data/test-implementations/Deployment/TestModule/Empty.cpp\E$
^\Qcmake/test/data/test-implementations/test-platforms/library.cmake\E$
mkdocs.yml
2 changes: 1 addition & 1 deletion .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ DDDTHH
ddl
ddmm
dealloc
debian
Debian
deconstructor
Deerin
defaultgen
Expand Down
10 changes: 9 additions & 1 deletion .github/workflows/markdown-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Check Markdown links

on:
push:
branches: [devel]
branches: [devel, docs/new-website]
pull_request:
branches: [devel]

Expand All @@ -11,6 +11,14 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4

- uses: ./.github/actions/setup

- name: 'Generate Doxygen and CMake docs'
run: |
sudo apt-get install -y doxygen
./docs/doxygen/generate_docs.bash

- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,5 @@ depend
/venv/

Packet-Views
docs/documentation/reference/api/cpp
docs/documentation/reference/api/cmake
3 changes: 1 addition & 2 deletions Autocoders/Python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,7 @@ Cmake file that is present in all parts of directory tree to be built by cmake.

### Requirements

The Autocoder's requirements are covered by installing the F´ software package. This is covered by the install document
found at: [INSTALL.md](../../docs/INSTALL.md).
The Autocoder's requirements are covered by installing the F´ software package. This is covered by the installation process.

## Schematron
In Autocoders/Python/schema/default there are various schematron .rng files mixed with the normal F Prime RelaxNG .rng schema files. The schematron files validate xml in the same way as the RelaxNG schemas (within the XmlParser classes), but these schematron files will only generate command line errors, not exceptions like the schema files will. Here is a short description of each file:
Expand Down
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ through how to contribute and the process contributions follow. Remember, we may
your submission the best it can be. Fear not! Your submission is still valued! You may even comment on other submissions
to help them improve.

Make sure to review our [style guidelines](./docs/UsersGuide/dev/code-style.md) when developing code to ensure it meets
the standards for F´´

## Ways of Contributing

The best way to contribute to F´ is to remain positive and engaged. Just about every contribution needs some improvement
Expand Down Expand Up @@ -45,8 +42,7 @@ To contribute to the F´ framework directly, consider writing
[needed documentation](https://github.com/nasa/fprime/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation) or starting
with an [easy first issue](https://github.com/nasa/fprime/issues?q=is%3Aissue+is%3Aopen+label%3A%22Easy+First+Issue%22).
When starting to modify F´ directly, ask questions, seek help, and be patient. Remember to review the project structure,
development process, and helpful tips sections below. Following the
[style guidelines](./docs/UsersGuide/dev/code-style.md) is a must for contributing code to F´.
development process, and helpful tips sections below.

## Project Structure

Expand Down
2 changes: 1 addition & 1 deletion Fw/Dp/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
This build module defines FPP ports and C++ classes that support
the collection and storage of data products.
For more information on data products and records, see the
[data products documentation](../../../docs/Design/data-products.md).
[data products documentation](../../../docs/documentation/user-manual/design/data-products.md).

## 2. Configuration

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ F´ (F Prime) is a component-driven framework that enables rapid development and
- A growing collection of ready-to-use components
- Testing tools for testing flight software at the unit and integration levels.

Learn more about F' key features [here](https://nasa.github.io/fprime/features.html).
Learn more about F´ key features [here](https://nasa.github.io/fprime/features.html).


## System Requirements
Expand Down
4 changes: 2 additions & 2 deletions RPI/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If the UART port is not set up correctly, there will be a file open error.

**Install the packages necessary to run the demo.**

Please see [INSTALL.md](../docs/INSTALL.md) to ensure that the F´ application has been installed and tested with the basic Ref. Additionally, the
Please see [install guide](../docs/getting-started/installing-fprime.md) to ensure that the F´ application has been installed and tested with the basic Ref. Additionally, the
cross-compilers need to be installed. This is done by installing the `gcc-arm-linux-gnueabihf` and `g++-arm-linux-gnueabihf` packages on the host
system. This is shown on Ubuntu below.

Expand All @@ -52,7 +52,7 @@ sudo apt update && sudo apt install -y gcc-arm-linux-gnueabihf g++-arm-linux-gnu

**Crosscompiling using CMake:**

The following commands are described at length in the getting started [tutorial](../docs/Tutorials/README.md). These commands will
The following commands are described at length in the [HelloWorld tutorial](../docs/documentation/tutorials/). These commands will
go to the RPI directory and generate a build directory for the RPI example. This step generates a CMake Cache, sets the toolchain use to build the
code and does an initial scan of the source tree. Since the RPI example sets a default F´ toolchain file in its CMakeLists.txt, we do not need to
supply one on the command line when generating the build. This only needs to be done once to prepare for the build because CMake will detect
Expand Down
6 changes: 2 additions & 4 deletions Ref/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Understanding the reference application has a few minimal prerequisites.

**Installing F´**

Please follow the install guide for F´ found here: [INSTALL.md](../docs/INSTALL.md).
Please follow the [install guide for F´](../docs/getting-started/installing-fprime.md).

## Building and Running the Ref Application

Expand Down Expand Up @@ -63,7 +63,5 @@ cd fprime/Ref/build-artifacts/<platform>/bin/
- The F´ utility's build command can build individual components too.
- The 'generate' command can take a toolchain argument for quickly generating a cross-compile `fprime-util generate raspberrypi` for example.

Further work with the F´ utility can be found in the [Getting Started](../docs/Tutorials/README.md) tutorial. Other tutorials
for many aspects of F´ are available [here](../docs/Tutorials/README.md).

Further work with the F´ utility can be found in the [HelloWorld tutorial](../docs/documentation/tutorials/) tutorial.

14 changes: 6 additions & 8 deletions cmake/API.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ endfunction(register_fprime_ut)
#
# This function allows users to register custom build targets into the build system. These targets are defined in a
# CMake file and consist of three functions that operate on different parts of the build: global, per-module, and
# per-deployment. See: [Targets](targets.md).
# per-deployment. See: [Targets](./target/target.md).
#
# This function takes in either a file path to a CMake file defining targets, or an short include path that accomplishes
# the same thing. Note: make sure the directory is on the CMake include path to use the second form. The supplied file
Expand Down Expand Up @@ -571,7 +571,6 @@ endmacro(register_fprime_list_helper)
# 1. Call one of `autocoder_setup_for_individual_sources()` or `autocoder_setup_for_multiple_sources()` from file scope
# 2. Implement `<autocoder name>_is_supported(AC_POSSIBLE_INPUT_FILE)` returning true the autocoder processes given source
# 3. Implement `<autocoder name>_setup_autocode AC_INPUT_FILE)` to run the autocoder on files filter by item 2.
# See: [Autocoders](dev/autocoder_integration.md).
#
# This function takes in either a file path to a CMake file defining an autocoder target, or an short include path that accomplishes
# the same thing. Note: make sure the directory is on the CMake include path to use the second form.
Expand Down Expand Up @@ -676,11 +675,10 @@ endfunction()

#### Documentation links
# Next Topics:
# - Setting Options: [Options](Options.md) are used to vary a CMake build.
# - Adding Deployments: [Deployments](deployment.md) create fprime builds.
# - Setting Options: [Options](options.md) are used to vary a CMake build.
# - Adding Modules: [Modules](module.md) register fprime Ports, Components, etc.
# - Creating Toolchains: [Toolchains](toolchain.md) setup standard CMake Cross-Compiling.
# - Adding Platforms: [Platforms](platform.md) help fprime set Cross-Compiling specific items.
# - Adding Targets: [Targets](targets.md) for help defining custom build targets
# - Implementation Packages Design: [Implementation Packages](/Design/package-implementor.md)
# - Creating Toolchains: [Toolchains](../../../user-manual/cmake/cmake-toolchains.md) setup standard CMake Cross-Compiling.
# - Adding Platforms: [Platforms](../../../user-manual/cmake/cmake-platforms.md) help fprime set Cross-Compiling specific items.
# - Adding Targets: [Targets](./target/target.md) for help defining custom build targets
# - Implementation Packages Design: [Implementation Packages](../../../user-manual/design/package-implementations.md)
####
2 changes: 1 addition & 1 deletion cmake/platform/platform.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# platforms:
#
# Platforms in F prime's CMake system setup f prime specific items w.r.t the OS. This file loads those platforms
# file and uses it to setup F prime's build. See: [Platform Template](./platform/platform-template.md) for how to
# file and uses it to setup F prime's build. See: [Platform Template](./platform-template.md) for how to
# generate these files.
#
####
Expand Down
2 changes: 1 addition & 1 deletion cmake/platform/platform.cmake.template
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# to remove the platform-failsafe (step 1) and fill in all <SOMETHING> tags.
#
# **Note:** If the user desires to set compiler paths, and other CMake toolchain settings, a
# toolchain file should be constructed. See: [toolchain.md](toolchain.md)
# toolchain file should be constructed. See: toolchain.md
#
# ### Platform File Loading ###
#
Expand Down
2 changes: 1 addition & 1 deletion cmake/sub-build/sub-build.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# implemented in this file. This includes the ability to setup targets, builds, and handle information passing back and
# forth between the modules.
#
# This file runs CMake on fprime, but registering only a set of target: (e.g. [fpp_locs](./target/fpp_locs.cmake) that
# This file runs CMake on fprime, but registering only a set of target: (e.g. fpp_locs that
# do the work on the build. This allows CMake to generate build information to be consumed at the generate phase while
# maintaining the efficiency of properly expressed builds.
####
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
####
# Linux.cmake:
#
# Linux platform file for standard linux targets. Merely defers to [./Linux-common.cmake](Linux-common.cmake).
# Linux platform file for standard linux targets. Merely defers to ./Linux.cmake.
####
include("${FPRIME_FRAMEWORK_PATH}/cmake/platform/Linux.cmake")
choose_fprime_implementation(Test/Implementation Test/Implementation/Platform)
Expand Down
2 changes: 1 addition & 1 deletion cmake/toolchain/toolchain.cmake.template
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# https://cmake.org/cmake/help/v3.12/manual/cmake-toolchains.7.html
#
# **Note:** If the user desires to set compile flags, or F prime specific build options, a platform
# file should be constructed. See: [platform.md](platform.md)
# file should be constructed. See: [platform.md](../platform/platform.md)
#
# ### Filling In CMake Toolchain by Example ###
#
Expand Down
Binary file removed docs/Architecture/ComponentTree.png
Binary file not shown.
23 changes: 0 additions & 23 deletions docs/Architecture/ComponentTree.puml

This file was deleted.

Binary file removed docs/Architecture/FPrimeArchitecture2023.pdf
Binary file not shown.
Binary file removed docs/Architecture/FPrimeArchitectureShort.pdf
Binary file not shown.
Binary file removed docs/Architecture/FPrimeSoftwareArchitecture.pdf
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/Design/fprime-architecture.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/Design/general.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/Design/img/com-adapter.txt

This file was deleted.

37 changes: 0 additions & 37 deletions docs/Design/integration-test-api.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/Design/memory.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/GettingStarted/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/HowTo/general.md

This file was deleted.

Loading
Loading