Welcome to the developer documentation for the Obsidian Plugin Template.Quick start guides and first steps for new developers.

📋 Contents## Getting Started

Getting Started### Quick Start

• Quick Start - Get up and running in 5 minutes- Quick Start Guide - Get up and running quickly

• Start Here - Comprehensive introduction for new developers - Installation

  • First build

Project Information - Testing in Obsidian

• Roadmap - Project roadmap and version planning

• Known Issues - Known bugs and limitations### First Steps

• Start Here - Comprehensive introduction

Feature Documentation - Project overview

See features/ for detailed feature-specific documentation: - Key concepts

• Debug system - Code elimination and size optimization - Development workflow

• Logger system - Tag-based filtering and component logging

• Build system - Build modes and compilation## Recommended Learning Path

🚀 Quick StartFor Complete Beginners:

1. Read Start Here for project overview

2. Install dependencies:2. Follow Quick Start for setup

   ```bash3. Review Coding Best Practices

   npm install4. Check Testing Checklist

   ```5. Explore Feature Documentation

3. Build the plugin:For Experienced Developers:

   ```bash1. Quick scan of Start Here

   npm run dev2. Run through Quick Start

   ```3. Dive into Architecture (when available)

4. Review Coding Best Practices

5. Test in Obsidian:

   • Files are copied to ../obsidian-dev-vault/.obsidian/plugins/## Key Resources

   • Reload plugin in Obsidian

• Build Commands: See Quick Reference

1. Make changes:- Coding Standards: See Coding Best Practices

   • Edit files in src/- Testing: See Testing Checklist

   • Run npm run dev again

   • Reload plugin## After Onboarding

📚 Key ResourcesOnce you’re comfortable with the basics:

• Explore Feature Documentation to understand specific systems

For Contributors- Read Coding Session Notes to see real-world examples

• Read Quick Start for setup- Review Maintenance Plans to see what’s planned

• Check Roadmap for current priorities

• Review Known Issues before reporting bugs## Getting Help

For Understanding the CodeIf you encounter issues:

• Explore Feature Documentation1. Check relevant Developer Guides

• Check code examples in examples/ (when available)2. Search Coding Sessions for similar problems

• Read inline JSDoc comments in source code3. Review Feature Documentation for specific systems

1. Consult main README for contact info

🤝 Contributing

Contributing

We welcome contributions! To get started:

Ready to contribute? Check:

1. Fork the repository- Current work in Maintenance Plans

2. Create a feature branch- Coding standards in Developer Guides

3. Make your changes- Testing requirements in References

4. Test thoroughly
5. Submit a pull request

Code Quality Standards

This project follows strict coding standards:

• File size limits: 500 lines max per file
• Strong typing: No any types
• Modular design: Single responsibility principle
• Error handling: Explicit try-catch blocks
• Documentation: JSDoc comments on public APIs

See the source code and copilot instructions for detailed guidelines.

🐛 Reporting Issues

Before reporting an issue:

1. Check Known Issues
2. Search existing issues on GitHub
3. Try with the latest version
4. Test with default theme and no other plugins

When reporting:

• Describe expected vs actual behavior
• Provide steps to reproduce
• Include Obsidian version
• Attach relevant console logs

📞 Getting Help

• Issues: Use GitHub Issues for bugs and feature requests
• Discussions: Use GitHub Discussions for questions
• Documentation: Check user docs for usage help

🗂️ Documentation Structure

docs/
├── user/              # User-facing documentation
├── developer/         # Developer documentation (you are here)
├── features/          # Feature-specific technical docs
└── examples/          # Code examples and demonstrations

All public documentation lives in docs/. Internal development notes are kept private in docs-internal/ (not committed to GitHub).

🔄 Versioning

This project uses semantic versioning (MAJOR.MINOR.PATCH):

• MAJOR: Breaking changes
• MINOR: New features (backwards compatible)
• PATCH: Bug fixes

See Roadmap for version planning.

📄 License

See LICENSE in the root directory.

---

Last Updated: February 16, 2026