Contribution Guide

Thank you for your interest in the GetFreeAI project! We welcome all forms of contribution to make this project better.

🎯 Ways to Contribute

📚 Documentation Architecture

GetFreeAI uses a modular documentation architecture, separating providers and services:

🏢 Provider Documents

Location: providers/{provider-name}/_index.md

Content:

• Basic information and introduction of the provider
• Company background and technical advantages
• General registration process (if shared across all services)
• List of services provided (links to Service documents)

Examples:

• providers/google-ai-studio/_index.md
• providers/groq/_index.md

🎯 Service Documents

Chatbot Service Location: services/chatbot/{service-name}/_index.md

Note: Directory names should not repeat “chatbot” or “chat”

Content:

• Access URL (required!)
• Available features (internet access, file upload, etc.)
• Usage limitations
• Usage steps and tips

Examples:

• services/chatbot/google-ai-studio/_index.md
• services/chatbot/deepseek/_index.md

API Service Location: services/api/{service-name}/_index.md

Note: Directory names should not repeat “api”

Content:

• API endpoint address
• List of available models
• Quotas and limitations (detailed table)
• Code examples (Python, cURL, etc.)
• Pricing information

Examples:

• services/api/google-ai-studio/_index.md
• services/api/groq/_index.md

🔗 Bidirectional Linking

• Provider documents link to all their Services
• Service documents link back to their Provider

Examples:

# In Provider document
Service Name

# In Service document
**Provider:** [Provider Name](/providers/provider-name)

📝 How to Add a New Provider

Step 1: Preparation

1. Read Documentation Standards

📖 Required Reading: Writing Guide

This detailed guide includes:

• Documentation architecture explanation
• Provider document standards
• Service document standards
• Writing style and format requirements
• Code example standards
• Research method suggestions

2. Check Document Templates

We provide three templates:

• 📋 Provider Template
• 💬 Chatbot Service Template
• 🔌 API Service Template

3. Reference Existing Documents

Check any complete Provider and its Services:

• Provider: /providers/google-ai-studio/
• Chatbot: /services/chatbot/google-ai-studio/
• API: /services/api/google-ai-studio/

Step 2: Research Information

Before starting to write, please ensure you have:

For Provider Documents

✅ Visit Official Website - Learn about company background and services
✅ Check Pricing Page - Understand free and paid services
✅ Read Official Documentation - Understand overall architecture
✅ Actually Register Account - Verify registration process

For Chatbot Service Documents

✅ Visit Chatbot Interface - Confirm access URL
✅ Test All Features - Verify internet access, file upload, code execution, etc.
✅ Test Usage Limits - Confirm daily limits, length restrictions
✅ Record Special Features - Note unique or useful features

For API Service Documents

✅ Read API Documentation - Understand endpoints, parameters, response formats
✅ Obtain API Key - Actually register and obtain key
✅ Run Code Examples - Ensure code can run
✅ Test Quota Limits - Verify request limits, token limits
✅ Verify Pricing Info - Confirm latest pricing

Step 3: Create Documents

Create Provider Document

# 1. Create Provider directory
mkdir -p providers/your-provider

# 2. Copy Provider template
cp templates/PROVIDER-TEMPLATE.md \
   providers/your-provider/_index.md

# 3. Edit document
# Fill in: basic info, company intro, registration process, service list

Create Chatbot Service Document (if applicable)

# Create directory and copy Chatbot template
mkdir -p services/chatbot/your-service
cp templates/SERVICE-CHATBOT-TEMPLATE.md \
   services/chatbot/your-service/_index.md

# Edit document
# Fill in: access URL, features, limitations, usage methods

Create API Service Document (if applicable)

# Create directory and copy API template
mkdir -p services/api/your-service
cp templates/SERVICE-API-TEMPLATE.md \
   services/api/your-service/_index.md

# Edit document
# Fill in: API endpoint, models, quotas, code examples

Step 4: Establish Bidirectional Links

Add service cards in Provider document:

## 🎁 Services Provided

### Chatbot Services


  Your Service
Brief description



### API Services


  Your Service API
Brief description

Link back to Provider in Service document:

**Provider:** [Your Provider](/providers/your-provider)

Step 5: Update Navigation

Edit hugo.yaml, add to menu.sidebar:

- name: Your Provider
  pageRef: /providers/your-provider
  parent: providers
  weight: 17  # Use next available number

Step 6: Quality Check

Use our checklist:

Provider Document Check

• Complete basic information (name, website, location, time)
• Clear company introduction (1-2 paragraphs)
• List all services provided
• Each service correctly links to Service document
• All related links are valid
• Format complies with standards

Chatbot Service Document Check

• Access URL clearly marked (most important!)
• Provider linked
• Complete feature list
• Clear usage limitations (table format)
• Actionable usage steps
• Format complies with standards

API Service Document Check

• Correct API endpoint address
• Provider linked
• Accurate model list
• Detailed quota limits (table format)
• Runnable Python code example
• Correct cURL example
• Latest pricing information
• Format complies with standards

📋 Submission Process

1. Fork the Project

# Fork the project to your GitHub account
# Then clone locally
git clone https://github.com/exdovic/getfreeai-content.git
cd getfreeai-content

2. Create Branch

# Create new branch
git checkout -b add-provider-name

# Or fix issue
git checkout -b fix-issue-description

3. Add Documents

# Add Provider document
git add providers/your-provider/_index.md

# Add Chatbot service document (if applicable)
git add services/chatbot/your-service/

# Add API service document (if applicable)
git add services/api/your-service/

# Update navigation config (if needed)
git add hugo.yaml

4. Commit Changes

# Commit
git commit -m "docs: add Provider Name and its service documents"

# Push to your repository
git push origin add-provider-name

5. Create Pull Request

1. Visit your forked repository
2. Click “New Pull Request”
3. Fill in PR description:

PR Title Example:

docs: add Anthropic (Claude) provider and service documents

PR Description Template:

## Added Content

- [ ] Provider document: Anthropic
- [ ] Chatbot service: Claude Chat
- [ ] API service: Anthropic API

## Completed Checks

- [ ] All information verified
- [ ] Code examples tested
- [ ] Access URLs confirmed
- [ ] Format complies with standards
- [ ] Bidirectional links established
- [ ] Navigation menu updated

## Additional Notes

[Any other notes if needed]

🎨 Naming Conventions

Provider Directory Naming

• All lowercase
• Use hyphens - as separators
• Use official English names

✅ google-ai-studio
✅ anthropic
✅ mistral-ai
❌ GoogleAIStudio
❌ google_ai_studio

Service Directory Naming

Chatbot Service Directories:

✅ claude/         (concise)
✅ gemini/         (concise)
✅ deepseek/       (concise)
❌ claude-chat/    (don't repeat "chat")
❌ claude-chatbot/ (don't repeat "chatbot")

API Service Directories:

✅ anthropic/      (concise)
✅ openai/         (concise)
✅ cohere/         (concise)
❌ anthropic-api/  (don't repeat "api")
❌ openai-api/     (don't repeat "api")

Notes:

• Each service is a directory containing an _index.md file
• Directory names should not include repetitive information like “chat”, “chatbot”, “api”
• Directory names use lowercase letters and hyphens

💡 Content Suggestions

Writing Style

• Clear and Direct - Avoid vague statements, use specific data
• User Perspective - Start from user needs, solve practical problems
• Friendly and Professional - Maintain courtesy and professionalism
• Practical First - Provide actionable guidance, not theory

Example Quality

• Runnable Code - Examples must be directly runnable
• Include Comments - Add necessary explanatory comments
• Mark Replacements - Clearly mark content that needs replacement (like API keys)
• Multi-language Support - Provide at least Python and cURL examples

Precautions

• Mark Limitations - Clearly state all limitations and warnings
• Explain Issues - Mention possible problems
• Provide Solutions - Give solutions or alternative suggestions
• Avoid Errors - Help users avoid common mistakes

🔍 Document Review Points

Content Completeness

• All required sections included
• Chatbot URL clearly marked (if applicable)
• Complete limitation and quota information
• Detailed actionable registration steps
• Complete and runnable code examples
• All links are valid
• Provider ↔ Service bidirectional links established

Format Standards

• Correct Markdown format
• Tables neatly aligned
• Appropriate emoji usage
• Code blocks have language tags (e.g., ```python {filename="Python"}`)
• External links use Markdown format (e.g., [URL](URL)), not plain URLs. Markdown formatted external links automatically display arrow icons (↗)
• Reasonable heading hierarchy (Provider uses #, sections use ##)
• Correct Front Matter configuration:
  • Include type: docs (required! Enables document layout and navigation)
  • Configure weight field (controls sorting)
  • Configure prev and next (enables previous/next navigation buttons at page bottom)
  • Include sidebar.open: true (automatically expands left sidebar)

Accuracy Verification

• All data verified
• Pricing information is latest
• Limitation descriptions accurate
• No outdated information
• Links are accessible
• Code examples tested

🐛 Report Issues

Found errors or outdated information? Please help us improve!

Report via Issue

1. Visit the project’s Issues page
2. Click “New Issue”
3. Choose appropriate template:
   • 📝 Documentation error
   • ❌ Outdated information
   • 💡 Improvement suggestion
   • 🆕 New provider request

Issue Description Points

Good Issue Title:

✅ [Google AI Studio] API quota information outdated
✅ [DeepSeek] Chatbot access URL invalid
✅ [Groq] Python code example cannot run
❌ There's a problem (too vague)

Issue description should include:

• Clear title - Briefly describe the problem
• Detailed description - Specifically explain the issue
• Screenshots or links - If applicable
• Suggested fix - If you know how to fix it
• Affected documentation - Clearly indicate which document

🌟 Top Contributors

We’ll showcase friends who have made outstanding contributions to the project here!

Contribution Types:

• 🏆 Add New Provider - Complete Provider + Services documentation
• 📝 Improve Existing Docs - Major improvements and updates
• 🐛 Fix Issues - Fix errors and outdated information
• 💡 Make Suggestions - Valuable improvement suggestions

📧 Contact Us

If you have any questions or suggestions:

• GitHub Issues - Raise questions or suggestions
• Pull Request - Submit improvements directly
• Email - [To be added]
• Discord - [To be added]

📜 Code of Conduct

By participating in this project, you agree to abide by our code of conduct:

• Respect Others - Friendly, inclusive, respect every contributor
• Constructive Discussion - Rational, objective, beneficial communication
• Professional Attitude - Responsible, serious, professional work style
• Open Source Spirit - Share, collaborate, progress together

We do not tolerate:

• Harassment, discrimination, offensive speech
• Spam, advertising, malicious content
• Plagiarism, theft of others’ work
• Violation of open source licenses

🎓 Learning Resources

Reference Existing Documents

Check out these excellent examples:

Complete Provider Examples:

• Google AI Studio - High free quota
• Groq - Technical advantage explanation
• OpenRouter - Multi-model aggregation
• DeepSeek - Chinese-optimized service

Chatbot Service Examples:

• Google AI Studio Chatbot
• DeepSeek Chat
• Cohere Coral

API Service Examples:

• Google AI Studio API
• Groq API
• OpenRouter API

Documentation and Tools

• Writing Guide - Detailed writing standards
• Template Library - Provider and Service templates
• Markdown Syntax - Markdown basics
• Hugo Documentation - Static site generator
• Hextra Theme - Documentation theme

📊 Contribution Statistics

Current Status:

• 🏢 Provider documents: 6
• 💬 Chatbot services: 7
• 🔌 API services: 6
• 📝 Total documents: 19

We need your help to add:

• OpenAI (ChatGPT, GPT API)
• Anthropic (Claude, Claude API)
• Mistral AI (Le Chat, Mistral API)
• Perplexity (Perplexity Chatbot)
• HuggingFace (Various free models)
• …More providers