Skip to content

Conversation

@ashleynilo
Copy link
Contributor

@ashleynilo ashleynilo commented Oct 14, 2024

Change Description

  • Combined most Arduino LEDBlinker Tutorial files into one in the following order:
    • README.md
    • project-setup.md
    • building-for-arduino.md
    • component-implementation-1.md
    • initial-integration.md
    • component-implementation-2.md
    • full-integration.md
    • running-on-hardware.md
  • Files not included
    • conclusion.md - was not included since that wasn’t in the original website
    • hardware.md - link on website now goes to hardware.md under LEDBlinker tutorial
  • Added two new files
    • uploading-to-board.md
    • arduino-cli-install.md
  • Updated headings so that there’s only one H1, each section (which were previously separate pages) now begins with an H2
  • Updated Table of Contents section with the new anchor links
  • Updated links so that all links point to absolute links since they are all pulled from separate repositories using the MkDocs multirepo plugin
  • Links are currently using the GitHub pages dev site, need to be updated to fprime.jpl.nasa.gov URLs once site goes live
  • Any Notes or sections with > have been converted to have Material for MkDocs Admonition/Callout styling. They now start with “!!! note” and are rendered normally when on the website.

Rationale

The F Prime website has been converted from regular markdown hosted on GitHub pages to using MkDocs framework with the Material theme. The Material for MkDocs theme includes three types of navigation: navigation tabs in the top menu, a left sidebar for sub-page navigation, and a right sidebar for page section navigation. The right sidebar now takes the place of the original left navigation menu on the old website. Now that there is a more robust navigation system, all the tutorial materials can be combined into one page so that relevant information stays grouped together.

Testing/Review Recommendations

Please focus on the flow of the combined sections and for any broken links. No other content was changed.

Future Work

  • Update links to go to the fprime.jpl.nasa.gov domain
  • Remove _include>toc.md since there is already a built in navigation with MkDocs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant