Contributing to the Codex¶

Help us improve and expand the New Dawn Codex!

How to Contribute¶

The New Dawn Codex is an open-source wiki built with MkDocs. We welcome contributions from the community!

Ways to Contribute¶

Submit Corrections: Fix errors or outdated information
Add Content: Write new guides or expand existing ones
Improve Clarity: Rewrite confusing sections
Add Examples: Provide helpful examples
Update Information: Keep content current

Getting Started¶

Prerequisites¶

GitHub account
Basic Markdown knowledge
Familiarity with the game

Fork and Clone¶

Fork the repository on GitHub
Clone your fork locally
Make your changes
Submit a pull request

Content Guidelines¶

Writing Style¶

Do:

Write clearly and concisely
Use proper grammar and spelling
Organize information logically
Include relevant examples
Be objective and factual

Don't:

Use slang or inappropriate language
Include personal opinions as facts
Add misleading information
Copy content from other sources

Formatting¶

Use Markdown for formatting:

# Main Heading
## Sub Heading
### Section

**Bold text**
*Italic text*
[Link text](url)

- Bullet point
1. Numbered list

!!! note "Callout Box"
    Important information here

Images¶

When adding images: - Use descriptive filenames - Optimize file size - Credit sources if needed - Place in appropriate directories

Content Areas¶

High Priority¶

Areas that need the most help: - Advanced strategies - Detailed skill guides - Specific item information - Quest walkthroughs - Server-specific features

Always Needed¶

Ongoing needs: - Updating outdated information - Fixing broken links - Improving clarity - Adding examples - Correcting errors

Review Process¶

Pull Request Guidelines¶

Clear Description: Explain your changes
Small Commits: Make focused changes
Test Locally: Build docs to check
Follow Style: Match existing format
Be Patient: Reviews take time

What We Look For¶

Accuracy of information
Quality of writing
Proper formatting
Relevance to players
No conflicts with existing content

Building Locally¶

Setup¶

# Install Python and pip
pip install -r requirements.txt

# Build the docs
mkdocs serve

# View at http://localhost:8000

Testing Changes¶

Build locally before submitting
Check all links work
Verify formatting
Test on mobile view
Review in dark mode

Community Contributions¶

Discussion¶

Before major changes: - Open an issue on GitHub - Discuss in Discord - Get community feedback - Collaborate with others

Credits¶

Contributors are recognized: - GitHub contributors list - Special mentions for major contributions - Community appreciation

Style Guide¶

Terminology¶

Use consistent terms: - "Magery" not "Magic skill" - "Hit Points" or "HP" - "Britannia" for the world - "New Dawn" for the server

Tone¶

Professional but friendly
Helpful and encouraging
Inclusive and welcoming
Patient with beginners

Resources¶

Helpful Links¶

Getting Help¶

Ask in Discord #codex channel
Open GitHub issue
Tag maintainers
Community will help!

Code of Conduct¶

Be Respectful¶

Treat all contributors with respect
Accept constructive criticism
Give helpful feedback
Support new contributors

Be Professional¶

No personal attacks
Stay on topic
Be patient
Focus on content quality

Thank you for helping make the Codex better!

Quick Start Checklist¶

Questions? Ask in Discord or open a GitHub issue!