mirrors/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2026-03-29 09:53:24 +01:00
Code Issues Projects Releases Packages Wiki Activity
Page: Documentation Standards & Guidelines
Pages
2048 3d printed enclosure ACARS (Aircraft Communications Addressing and Reporting System) ACARS ADS B(S) AFSK AIS Boats APRS RX APRS TX About firmwares Access Radio Hardware Add GPIO to H2 Adult Toys Analog TV Receiver Antennas Applications At first glance Audio Receivers Automatic dependent surveillance–broadcast (ADS B) BHT BLESpam Battleship Bitmap reverse decode Blackjack Bluetooth Low Energy Receiver Bluetooth Low Energy Transmitter Boot Process Breakout Burger Pager C16 format CVS Spam Calculator Capture Care Cart Lock ChibiOS Notes Clifford's version Code contribution rules Code formatting Compile firmware Compile on Arch based distro (exclude Asahi) Compile on WSL with ninja Completely reset Config Menu Contributing Guidelines Contributors Create a Custom Map with Offline Map Maker Create a Simple App Create a custom splash screen Create a custom splash screenhome Create a simple external app Creating a prod stable release DFU overlay Dead Coin Cell Battery Debug via SWD & JTAG Debug with serial Debug Decoder for NRF24L01 Description of the Structure Detector Dev build versions Diagnose firmware update in Windows Differences Between H1 and H2 models Digital Rain Dino Game Dissecting the Temperature logger Documentation Standards & Guidelines Doom EPIRB RX (Emergency Position‐Indicating Radio Beacon Receiver) EPIRB RX EPIRB TX ERT Encoder External App Roadmap External apps informations FAQ FPV Detect Factory Defaults Features File manager Firmware Architecture First steps Flash Mayhem onto bare HackRF Flash Utility Flex RX FlipperTX Fox Hunt Freq manager Freqman manager Full reset GPS Sim GSG hackrf GUI Widget Preview Games General Compiling Guide (Linux) H2 Enclosure H2 Plus speaker modifications HackRF Pro HackRF Hardware overview Help! Im not receiving anything! Receive Quality Issues Home Hopper How to Format SDCard How to ask questions in correct way How to collaborate How to compile faster with WSL 2 I2C external device driver integration IQ trim Information on APRS Intended Use and Legality Internal speaker Interpret Guru meditation crashes Jammer KISS TNC KeeLoq TX Key fob TX Keyboard view LCR LGE Tool Level Looking Glass MDC TX MDC 1200 TX Main Controls Main Menu Maintaining rules Make airlines db Make icao24 db Metronome Microphone Tranceiver Microphone Transceiver Morse P Morse RX Morse TX NOAA No TX or RX Notepad Notes About ccache OOK Brute OOK Editor OOK Original GSG HackRF One P25 Tx POCSAG Receiver POCSAG Tx PR process Pac‐Man Persistent Memory Playlist Editor Playlist PortaPack Versions Powering the PortaPack Preamplifier IC replacement ProtoView Push buttons and button caps RDS RTTY RX RTTY TX Radio Radiosonde Random password Receivers Recon Redirections Remote Replay SAME TX SD Card (DEV) SD Card Content SD Over USB SD card not recognized by PC with the SD card over USB selected SMA connector replacement or removal SSTV RX SSTV Scanner Screenshots Search Settings Signal Generator Sleep mode Snake Software Dev Guides Soundboard Space Invaders Spectrum Painter Splash and other images Stealth Mode Stopwatch SubCar SubGhzD TPMS RX TPMS TX TX Carrier Only Tetris Text Entry Theme system Time Sink Title Bar TouchTunes Transceivers Transmitters Troubleshooting Tuner UI Screenshots UI positioning with macros USB Serial Console USB‐C charging modification for older HackRF boards Unit Tests Update firmware for more detailed information Update firmware troubleshooting Update firmware Updating the Xilinx CPLD on hackrf board Usage cautions User interface Using MAC OS Utilities WardriveMap Waterfall Designer Wav viewer Weather WeatherFax Web USB Serial What if I don't like some of the apps Widgets Wipe SD Card Won't boot Won Wont boot Work Needed World map generation gfxEQ imagemagick.org waterfalls color schemes
3 Documentation Standards & Guidelines
Gerry Kavanagh edited this page 2020-07-06 16:38:53 +01:00
Table of Contents

General Style Guidelines

  • Language should be English
  • Style should tend more toward "user manual" than "blog post".
  • Images should (where possible) be located in the wiki git repository in 'img/'.

Page Structure

Applications Pages

Applications Pages should adhere to he following structure:

High Level Description

This is a brief description of the Application. Limit to 3 or 4 sentences. No need for elaboration of terms or definitions.

User Interface

What the various regions and controls on the UI do. This should contain a screenshot with the various regions highlighted.

Functionality

Detailed description of the usage of the application.

Examples

Specific use-cases. Possible inclusions - sample file outputs, screenshots etc.

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Start here

Contributors

How to collaborate
Contributing Guidelines
How to ask questions correctly

Hardware

User manual

Intended use and Legality

Applications

Misc

Developer Manual

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Note

The wiki is incomplete. Please add content and collaborate.

Important

  • This is a public wiki. Everything is visible to everyone. Don't use it for personal notes.
  • Avoid linking to external tutorials/articles; they may become outdated or contain false information.