Apoc Gardens Wiki Contribution Guide

Table of Contents

1. Project Overview
2. Prerequisites
3. Getting Started
4. Cloning the Repository
5. Adding a New Crop
6. Submission Process
7. Quality Guidelines
8. Self Hosting

Project Overview

This project aims to create a comprehensive database of crop and plant documentation for Sri Lankan climatic conditions, providing detailed information about various agricultural and horticultural species.

Prerequisites

Before contributing, ensure you have:

• A GitHub account
• Git installed on your local machine
• Basic understanding of markdown formatting
• Reliable sources for crop information

Getting Started

Cloning the Repository

There are multiple ways to clone the repository:

Method 1: Using HTTPS (Recommended for beginners)

# Open your terminal or command prompt
# Navigate to the directory where you want to clone the repository
cd path/to/your/projects/directory

# Clone the repository
git clone https://github.com/team-watchdog/apoc-gardens-wiki.git

# Navigate into the project directory
cd crop-documentation-project

Method 2: Using SSH (Recommended for advanced users)

# Ensure you have SSH keys set up with GitHub
# Clone the repository
git clone git@github.com:team-watchdog/apoc-gardens-wiki.git

# Navigate into the project directory
cd apoc-gardens-wiki

Adding a New Crop

All the crop information is mentioned in markdown (.md) format. The existing crops are located in public/markdown folder. First, navigate to this folder by;

cd public/markdown

Folder Structure Guidelines

1. Category Folders:

   • Use Capital Case with Spaces
   • Examples:
     • Vegetables
     • Fruits
     • Herbs & Spices
     • Roots

2. File Naming Convention:

   • Use lowercase
   • Separate words with hyphens
   • .md extension
   • Examples:
     • tomato.md
     • red-onion.md
     • star-fruit.md

Step-by-Step Process

1. Create/Choose Category Folder

   # If the category doesn't exist
   mkdir "Crop Category"
   
   # Navigate to the folder
   cd "Crop Category"

2. Create Markdown File

   # Create a new markdown file following naming conventions
   touch crop-name.md

3. File Template Use the following template exactly when creating your markdown file:

   # [Crop Name]
   ![Plant/Flower Image](path/to/image.jpg "Image attribution")
   
   ## General Information
   **Generic name:** 
   **Local names:** 
   **Scientific name:** 
   **Plant family:** 
   **Edible parts:** 
   **Nutrition value:** 
   
   **Companion plants:**
   - 
   - 
   - 
   
   **Non-companion plants**
   - 
   - 
   
   ## Description:
   [Detailed description of the plant, including varieties, characteristics, and general appearance]
   
   ## Planting requirements
   **Planting season:** 
   
   ### Planting conditions:
   | Propagation | |
   |----|----|
   | Planting method | |
   | Soil | |
   | Water | |
   | Light | |
   | Fertiliser | |
   
   ### Growing conditions:
   | Temperatures | |
   |----|----|
   | Soil | |
   | Water | |
   | Pruning | |
   | Weed control | |
   
   ## Harvesting:
   [Instructions for harvesting]
   
   ## Curing:
   [Curing process, if applicable]
   
   ## Storage
   [Storage instructions]
   
   ## Protecting your plants
   ### Pest control
   **Pest type:**
   - 
   - 
   
   **Symptoms:**
   - **[Pest Name]:** 
   - 
   
   **Control method:**
   - **[Pest Name]:** 
   
   ### Disease Control
   **Disease type:**
   - 
   - 
   
   **Symptoms:**
   - **[Disease Name]:** 
   - 
   
   **Management:**
   - **[Disease Name]:** 
   
   ## Difficulty Rating
   ### [Region/Climate Zone] (Difficulty: X/10)
   **Explanation:** 
   **Challenges/Adaptations:**
   - 
   - 
   
   ## References for this entry
   ### Sources:
   - 
   - 
   

Submission Process

Creating a Pull Request

1. Create a New Branch

   # Create and switch to a new branch
   git checkout -b add-[crop-name]

2. Stage Your Changes

   # Add your new files
   git add.
   
   # Commit with a clear message
   git commit -m "Add documentation for [Crop Name] in [Category]"

3. Push to Your Fork

   git push origin add-[crop-name]

4. Create Pull Request

   • Go to the GitHub repository
   • Click "New Pull Request"
   • Select your branch
   • Provide a detailed description of your contribution

Quality Guidelines

• Use reputable, verifiable sources
• Provide scientific names
• Include comprehensive information
• Cite sources accurately
• Ensure information is current and accurate
• Use clear, concise language

Tips for Successful Contribution

• Research thoroughly before submitting
• Use academic and agricultural research sources
• Include images with proper attribution
• Be precise in botanical and agricultural descriptions
• Consider multiple climate zones

Self Hosting

In the case of self-hosting, the source code mentions scripts that can convert all the markdown files into the wiki format and store them as static HTML files. These static HTML files can be hosted in any hosting service, e.g. Github Pages (currently hosted in), Netlify, Google Cloud, etc.

Running Scripts

If you change anything in the typescript code or tailwind file, run the following script to compile the code down to JavaScript and proper CSS.

npm run build

After running the compiler you run the script by running the following command

npm run start

This will create all the updated static pages that can be seen in the public folder.

Hosting Locally

To host the website locally to check if the changes are in place first install the npm package serve,

npm install --global serve

Then run the following command,

npm run serve

Host the website by only uploading the public folder.

Contact

For questions or clarifications, please open an issue in the repository.