📚 N.I.N.A. Documentation

This repository contains the source files for the documentation of N.I.N.A. – Nighttime Imaging 'N' Astronomy.

📖 The live documentation is available at:
https://nighttime-imaging.eu/docs/master/site/

---

✍️ Contributing

We welcome all contributions - from fixing typos to writing new guides or documenting upcoming features.

Please read our Contributing Guide for full details on:

• Setting up the environment with MkDocs
• Building and previewing the docs locally
• The branching model used for contributions
• How pull requests are handled and deployed

---

⚙️ Quick Setup

To get started locally, follow these steps:

1. Install Python
2. Upgrade pip:

   pip install --upgrade pip

3. Install MkDocs and required plugins:

   pip install mkdocs mkdocs-material mkdocs-with-pdf

4. Start the local development server:

   mkdocs serve

5. Open the browser at the address shown in the terminal to view the docs live.

---

🌿 Branching Model

• master: live documentation for the latest stable release
• develop: live documentation for the nightly builds

Documentation updates are deployed automatically via GitHub Actions when pull requests are merged into master or develop.

---

📌 Guidelines

• Create pull requests from your fork.
• PRs for new features should target the develop branch.
• Test your changes locally by running mkdocs serve.
• Keep each PR focused on a single topic/feature.
• Ensure your content follows the general tone and structure of existing documentation.

---

💬 Need Help?

• 🔧 Main application repo: github.com/isbeorn/N.I.N.A
• 🧠 Real-time support: Discord Community
• 🌐 More resources: nighttime-imaging.eu

---

⚖️ License

This project is licensed under the Mozilla Public License 2.0.
See the LICENSE file for details.