Skip to content

Conversation

@langestefan
Copy link
Member

A tutorial on adding new algorithms to SolarPosition.jl.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation guides for SolarPosition.jl and reorganizes the documentation structure from "examples/" to "guides/". The primary addition is a detailed tutorial on how to add new solar position algorithms to the package.

Key Changes

  • Added a new comprehensive guide for contributing new algorithms (new-algorithm.md)
  • Reorganized documentation from examples/ to guides/ directory
  • Moved existing documentation files to the new structure with updated cross-references

Reviewed changes

Copilot reviewed 6 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
examples/benchmark_threading.jl Updated path references from examples/ to guides/
docs/src/index.md Updated ModelingToolkit extension reference to new path
docs/src/guides/plotting.md New guide for plotting with Makie.jl (moved from examples)
docs/src/guides/parallel.md New guide for parallel computing with OhMyThreads.jl (moved from examples)
docs/src/guides/new-algorithm.md New comprehensive tutorial for adding solar position algorithms
docs/src/guides/modelingtoolkit.md New guide for ModelingToolkit.jl integration (moved from examples)
docs/src/guides/getting-started.md New getting started guide (moved from examples)
docs/src/contributing.md Added reference to new algorithm guide
docs/make.jl Updated documentation structure from "Examples" to "Guides"
.codecov.yml Updated coverage ignore path from examples/ to guides/

@codecov
Copy link

codecov bot commented Nov 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.02%. Comparing base (ebf3b44) to head (4552bf5).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #23   +/-   ##
=======================================
  Coverage   99.02%   99.02%           
=======================================
  Files          15       15           
  Lines         511      511           
=======================================
  Hits          506      506           
  Misses          5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@langestefan langestefan merged commit 25c87cb into main Nov 29, 2025
15 checks passed
@langestefan langestefan deleted the algtutorial branch November 29, 2025 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant