JuliaConstraints / JuliaConstraints/JuliaConstraints.github.io

Aggregate the documentation of packages in Julia Constraints

Open
#2 0 comments 0 reactions 1 assignee View on GitHub

@Azzaare is already working on this.

Since Mar 26, 2024.

documentation enhancement good first issue help wanted
Dominant language
Julia
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Documentation of most packages should be aggregated into the Julia Constraints website. @autodocs can be used in those packages to provide version-based documentation. README and doc there should point to the umbrella website.

  • JuliaConstraints.github.io
    • JuliaConstraints/PerfChecker.jl#26
    • Constraint Modeling
      • JuliaConstraints/ConstraintCommons.jl#10
      • JuliaConstraints/ConstraintDomains.jl#40
      • JuliaConstraints/Constraints.jl#38
      • ConstraintModels.jl
      • COPInstances.jl
      • KumiKumiSlopes.jl
    • Learning
      • JuliaConstraints/CompositionalNetworks.jl#57
      • JuliaConstraints/QUBOConstraints.jl#10
      • JuliaConstraints/ConstraintLearning.jl#9
    • Solvers
      • JuliaConstraints/LocalSearchSolvers.jl#116
      • JuliaConstraints/CBLS.jl#24
      • Others

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.