arn-c0de / arn-c0de/InteractiveChecklists

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

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue help wanted priority: low ready for review testing
Dominant language
Kotlin
Stars
45
Forks
4
PR merge metrics
No merged PRs in 30d

Description

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//
```

**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

Contributor guide

Open the contributing guide

Research direction

Review the existing Markdown files in app/src/main/assets/ as templates, then choose content that fits the requested checklists, manuals, charts, or reference documentation. Place Markdown or PDF files in the required directory, using aircraft-named subdirectories for checklists. Done means the content follows the structure, naming, formatting, and licensing requirements and is submitted in a pull request.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.