Skip to content

Conversation

@WizzardDr
Copy link
Contributor

@WizzardDr WizzardDr commented Jul 11, 2025

PR Type

Documentation


Description

This description is generated by an AI tool. It may have inaccuracies

  • Added comprehensive GitHub Codespaces build guide for INAV

  • Includes step-by-step setup, modification, and build instructions

  • Provides terminal commands for cmake build process

  • Contains screenshots and download instructions for hex files


Changes diagram

flowchart LR
  A["Setup Codespace"] --> B["Modify Code"]
  B --> C["Prepare Build"]
  C --> D["Build Target"]
  D --> E["Download Hex File"]
Loading

Changes walkthrough 📝

Relevant files
Documentation
Building in Github Codespace.md
GitHub Codespaces build documentation                                       

docs/development/Building in Github Codespace.md

  • Created new documentation file for GitHub Codespaces
  • Added step-by-step build instructions with cmake commands
  • Included screenshots and examples for each build step
  • Provided guidance on target selection and file download
  • +48/-0   

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • @qodo-code-review
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    ⚡ Recommended focus areas for review

    Typos/Grammar

    Multiple spelling and grammar errors throughout the document that should be corrected for professional documentation quality

    > This guild provides a simple method to modify and build a version of INAV in the cloud.**
    
    ## Setup
    1. Navigate to the version of INAV you want to modify.
    2. Create a new codespace for that version. `Code> Codespaces> Create codespace on 8.x.x.`
    <img width="1567" height="769" alt="image" src="https://github.com/user-attachments/assets/4427ea1e-19ff-4c2c-8d99-3870c13f767b" />
    
    > A new codespace will launch in your browser.
    
    
    ## Modify
    3. Modify the code as required.
       You can freeley modify your copy of the INAV code from within the cloud environment.
    
    ## Build
    Use the terminal inside the codespace environment to run the following commands:
    
    ### Prepare
    #### 4. Prepare the build:
    ```bash
    cmake -B build -S .
    image > Note: You may need to use ctrl+C to exit the process and return to the shell once it completes.

    Target

    5. (Optional) If you don't know your target name, list the availble targests with:

    cmake --build build --target help
    image

    Build

    6. Build the binary (replace the target name with your specific one):

    cmake --build build --target NEUTRONRCF435MINI
    image

    Download

    1. Once the build process has complete, download the .hex binary from the build folder on the right.
      Example: inav_8.0.1_NEUTRONRCF435MINI.hex (Right-click > Download.
    image

    Note: Codespaces are automatically deleted after a period of inactivity, or you can manually deleted them at https://github.com/codespaces

    
    </details>
    
    <details><summary><a href='https://github.com/iNavFlight/inav/pull/10957/files#diff-c18543838f1ade043f08171907ece1fe7498b5879f468c42eb3d48fa101e9f4fR44-R44'><strong>Missing Punctuation</strong></a>
    
    Incomplete sentence structure and missing closing parenthesis in the download instructions
    </summary>
    
    ```markdown
       Example: `inav_8.0.1_NEUTRONRCF435MINI.hex` (Right-click > Download.
    <img width="1566" height="978" alt="image" src="https://github.com/user-attachments/assets/fd3bdeb4-459f-433b-ab70-74a49b26712f" />
    

    @qodo-code-review
    Copy link
    Contributor

    qodo-code-review bot commented Jul 11, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @DzikuVx DzikuVx added this to the 9.0 milestone Jul 21, 2025
    @DzikuVx DzikuVx merged commit 9f0fb42 into iNavFlight:master Jul 21, 2025
    1 check passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants