Skip to content

Looking for Content Contributions (Checklists, Manuals, Charts, …) #8

Description

@arn-c0de

We are currently seeking additional content contributions for this application.

Scope of Requested Content

We welcome the creation and improvement of the following materials:

  • Checklists
  • Manuals
  • Charts
  • Other relevant reference documentation suitable for in-app use

Supported File Formats

  • ✅ Markdown (.md) — preferred
  • ✅ PDF (.pdf)

Formatting Guidelines

  • Use existing Markdown files in the repository as a reference and template
  • Example files and fill-in templates will be provided at a later stage
  • Core conventions:
    • ## headings define sections / containers
    • - [ ] denotes checklist items

Directory Structure

All files must be placed in the following directory:

app/src/main/assets/

Checklist Storage

Checklists must reside in a subdirectory named after the respective aircraft:

app/src/main/assets/Checklists/<Aircraft-Name>/

Example:

app/src/main/assets/Checklists/F-14B/

Review and Quality Improvements

  • Existing checklists should be reviewed and validated for completeness
  • Corrections, structural improvements, and original enhancements are explicitly encouraged
  • Contributors are welcome to refine wording, optimize sequencing, and add missing or clarifying steps

Licensing Requirements

All contributed material must be:

  • Original work, or
  • Derived from public-domain sources (e.g. FAA publications or unrestricted U.S. Government documents), or
  • Used with permission of the copyright holder

Do not submit content sourced from:

  • Manuals with distribution restrictions (e.g. “Official Use Only”, Distribution Statement B or C)
  • Publications labeled “All Rights Reserved”

Contribution Process

  1. Add new content or improve existing files
  2. Review and, where possible, validate existing checklists
  3. Adhere strictly to the defined folder structure
  4. Commit changes and submit a Pull Request

General Guidelines

  • Maintain clear structure and consistent naming
  • Prefer Markdown for optimal in-app readability
  • Ensure all content complies with the stated licensing requirements

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelates to docs or README updatesenhancementSuggests an improvement or new featuregood first issueSuitable for newcomers/contributorshelp wantedContributions from others are welcomepriority: lowMinor importanceready for reviewCompleted, awaiting reviewtestingRelated to tests or test coverage

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions