Skip to content

Add JavaScript programming documentation#11143

Merged
sensei-hacker merged 2 commits intoiNavFlight:masterfrom
sensei-hacker:docs_javascript_programming
Nov 29, 2025
Merged

Add JavaScript programming documentation#11143
sensei-hacker merged 2 commits intoiNavFlight:masterfrom
sensei-hacker:docs_javascript_programming

Conversation

@sensei-hacker
Copy link
Member

@sensei-hacker sensei-hacker commented Nov 29, 2025

User description

Summary

  • Adds JavaScript programming documentation to docs/javascript_programming/
  • Updates docs/Programming Framework.md with cross-links to the new JS programming docs

Documentation Added

  • JAVASCRIPT_PROGRAMMING_GUIDE.md - Main guide for JS-based programming
  • OPERATIONS_REFERENCE.md - Complete reference for supported operations
  • TIMER_WHENCHANGED_EXAMPLES.md - Practical examples for time-based patterns
  • TESTING_GUIDE.md - How to test JavaScript programs
  • GENERATE_CONSTANTS_README.md - Constants generation documentation
  • api_definitions_summary.md / api_maintenance_guide.md - API documentation
  • implementation_summary.md / index.md - Overview docs
  • Supporting images (screenshots)

Changes to Existing Docs

  • docs/Programming Framework.md - Added "JavaScript-Based Programming (Alternative)" section and "Related Documentation" links

Description

  • Adds comprehensive JavaScript programming documentation

  • Documents all INAV logic condition operations and patterns

  • Provides API definitions structure and maintenance guide

  • Includes testing guide and implementation details

  • Updates Programming Framework with JavaScript alternative link


Diagram Walkthrough

flowchart LR
  A["Programming Framework.md"] -->|cross-links| B["JavaScript Programming Docs"]
  B --> C["User Guides"]
  B --> D["Developer Docs"]
  C --> C1["Quick Reference"]
  C --> C2["Operations Reference"]
  C --> C3["Timer/WhenChanged Examples"]
  D --> D1["Implementation Summary"]
  D --> D2["Testing Guide"]
  D --> D3["API Definitions"]
  D --> D4["API Maintenance"]
Loading

File Walkthrough

Relevant files
Documentation
11 files
Programming Framework.md
Add JavaScript programming section and links                         
+22/-0   
JAVASCRIPT_PROGRAMMING_GUIDE.md
Main JavaScript programming quick reference guide               
+247/-0 
OPERATIONS_REFERENCE.md
Complete reference for all INAV operations                             
+123/-0 
TIMER_WHENCHANGED_EXAMPLES.md
Practical examples for timer and change detection               
+292/-0 
TESTING_GUIDE.md
Comprehensive guide for testing transpiler changes             
+260/-0 
GENERATE_CONSTANTS_README.md
Documentation for constants generation from firmware         
+166/-0 
api_definitions_summary.md
Overview of INAV API definitions structure                             
+280/-0 
api_maintenance_guide.md
Step-by-step guide for maintaining API definitions             
+396/-0 
implementation_summary.md
Technical architecture and design overview                             
+216/-0 
TIMER_WHENCHANGED_IMPLEMENTATION.md
Technical implementation details for timer and delta         
+151/-0 
index.md
Main documentation index and table of contents                     
+286/-0 

@qodo-code-review
Copy link
Contributor

qodo-code-review bot commented Nov 29, 2025

PR Compliance Guide 🔍

All compliance sections have been disabled in the configurations.

Changed createLogicCondition (which doesn't exist) to pushLogicCommand
with correct signature: (operation, operandA, operandB, activatorId)
@sensei-hacker sensei-hacker merged commit 2be60b3 into iNavFlight:master Nov 29, 2025
1 check passed
@sensei-hacker sensei-hacker added this to the 9.0 milestone Nov 29, 2025
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.

1 participant