-
-
Notifications
You must be signed in to change notification settings - Fork 520
Documentation Standards & Guidelines
Gerry Kavanagh edited this page Jul 6, 2020
·
3 revisions
- 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/'.
Applications Pages should adhere to he following structure:
This is a brief description of the Application. Limit to 3 or 4 sentences. No need for elaboration of terms or definitions.
What the various regions and controls on the UI do. This should contain a screenshot with the various regions highlighted.
Detailed description of the usage of the application.
Specific use-cases. Possible inclusions - sample file outputs, screenshots etc.
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.
How to collaborate
How to ask questions correctly
- First steps
- Usage cautions
- Intended use and Legality
- Features
- PortaPack Versions (which one to buy)
- HackRF Versions
- Firmware update procedure
- Description of the hardware
- User interface
- Powering the PortaPack
- Troubleshooting
- Applications
-
Compilation of the firmware
- How to compile on Windows faster with WSL 2
- Using Docker and Kitematic
- Docker command-line reference
- Using Buddyworks and other CI platforms
- Notes for Buddy.Works (and other CI platforms)
- Using ARM on Debian host
- All in one script for ARM on Debian host
- Compile on Arch based distro (exclude Asahi)
- Dev build versions
- Create a custom map
- Code formatting
- PR process
- Description of the Structure
- Software Dev Guides
- Tools
- Research
- UI Screenshots
- Maintaining
- Creating a prod/stable release (Maintainers only)
- Maintaining rules
- Development States Notes