Home page and restructuration

JuliaConstraints · Mar 9, 2024 · 4a53b44 · 4a53b44
1 parent 48c841e
commit 4a53b44
Show file tree

Hide file tree

Showing 18 changed files with 53 additions and 29 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -42,32 +42,37 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
-        "Getting Started" => "getting_started.md",
-        "Performance Checking" => [
-            "PerfChecker.jl" => "perf_checker.md",
-            "BenchmarkToolsExt" => "benchmark_ext.md",
-            "Interface" => "perf_interface.md",
+        "Constraint Programming" => [
+            "Introduction" => "cp/intro.md",
+            "Optimization(s)?" => "cp/opt.md",
         ],
         "Constraints" => [
-            "ConstraintCommons.jl" => "constraint_commons.md",
-            "ConstraintDomains.jl" => "constraint_domains.md",
-            "Constraints.jl" => "constraints.md",
-            "ConstraintModels" => "constraint_models.md",
+            "ConstraintCommons.jl" => "constraints/constraint_commons.md",
+            "ConstraintDomains.jl" => "constraints/constraint_domains.md",
+            "Constraints.jl" => "constraints/constraints.md",
+            "ConstraintModels" => "constraints/constraint_models.md",
         ],
         "Learning" => [
-            "CompositionalNetworks.jl" => "compositional_networks.md",
-            "QUBOConstraints.jl" => "qubo_constraints.md",
-            "ConstraintLearning.jl" => "constraint_learning.md",
-        ],
-        "JuMPed Solvers" => [
-            "CBLS.jl" => "cbls.md",
+            "CompositionalNetworks.jl" => "learning/compositional_networks.md",
+            "QUBOConstraints.jl" => "learning/qubo_constraints.md",
+            "ConstraintLearning.jl" => "learning/constraint_learning.md",
         ],
-        "Raw Solvers" => [
-            "LocalSearchSolvers.jl" => "local_search_solvers.md",
+        "Solvers" => [
+            "JuMPed" => [
+                "CBLS.jl" => "solvers/cbls.md",
+            ],            
+            "Others" => [
+                "LocalSearchSolvers.jl" => "solvers/local_search_solvers.md",
+            ],
         ],
         "Meta Strategist" => [
-            "MetaStrategist.jl" => "meta_strategist.md",
-        ]
+            "MetaStrategist.jl" => "meta/meta_strategist.md",
+        ],
+        "Performance Checking" => [
+            "PerfChecker.jl" => "perf/perf_checker.md",
+            "BenchmarkToolsExt" => "perf/benchmark_ext.md",
+            "Interface" => "perf/perf_interface.md",
+        ],
     ],
     warnonly = true,
 )

diff --git a/docs/src/constraint_commons.md → docs/src/constraints/constraint_commons.md b/docs/src/constraint_commons.md → docs/src/constraints/constraint_commons.md
diff --git a/docs/src/constraint_domains.md → docs/src/constraints/constraint_domains.md b/docs/src/constraint_domains.md → docs/src/constraints/constraint_domains.md
diff --git a/docs/src/constraint_models.md → docs/src/constraints/constraint_models.md b/docs/src/constraint_models.md → docs/src/constraints/constraint_models.md
diff --git a/docs/src/constraints.md → docs/src/constraints/constraints.md b/docs/src/constraints.md → docs/src/constraints/constraints.md
diff --git a/docs/src/getting_started.md → docs/src/cp/intro.md b/docs/src/getting_started.md → docs/src/cp/intro.md
diff --git a/docs/src/cp/opt.md b/docs/src/cp/opt.md
@@ -0,0 +1,4 @@
+# The World of Optimization 
+
+Comparison and guidelines about the different way to do optimization.
+
diff --git a/docs/src/index copy.md → docs/src/index-old.md b/docs/src/index copy.md → docs/src/index-old.md
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -12,15 +12,11 @@ hero:
     alt: JuliaConstraints
   actions:
     - theme: brand
-      text: Getting Started
-      link: /getting_started
+      text: Constraint Programming ?!
+      link: /constraint_programming
     - theme: alt
       text: View on Github
-      link: https://github.com/JuliaConstraints/JuliaConstraints.github.io
-    - theme: alt
-      text: API Examples
-      link: /cbls
-      
+      link: https://github.com/JuliaConstraints/JuliaConstraints.github.io      
 
 features:
   - icon: <img width="64" height="64" src="JuMP-logo-dark.png" alt="JuMP.jl"/>
@@ -43,8 +39,27 @@ features:
 
 <div class="vp-doc" style="width:80%; margin:auto">
 
-<h1> What is Julia Constraints? </h1>
+<h1>What is Julia Constraints? (chatGPTed atm)</h1>
+
+<p>The Julia Constraints organization is dedicated to advancing Constraint Programming within the Julia ecosystem, serving as a hub for resources that facilitate the creation, understanding, and solution of constraint programming problems. Our goal is to make Constraint Programming accessible and efficient for users at all levels of expertise, by providing a comprehensive suite of tools that integrate seamlessly with JuMP.jl, a popular Julia package for mathematical optimization.</p>
+
+<h2>Our offerings include:</h2>
+
+<h3>Core Packages:</h3>
+<p>A foundation of common packages (ConstraintCommons, ConstraintDomains, Constraints, ConstraintModels) that supply essential features for constraint programming, ensuring users have the basic tools necessary for their projects.</p>
+
+<h3>Learning and Translation Tools:</h3>
+<p>Advanced packages like CompositionalNetworks, QUBOConstraints, and ConstraintsTranslator bridge the gap between ease of modeling and computational efficiency. These tools learn from constraints and convert natural language problems into constraint programming solutions, requiring minimal input from the user beyond the model itself.</p>
+
+<h3>Solvers:</h3>
+<p>We provide a range of solvers, from native Julia solvers (LocalSearchSolvers) to interfaces with JuMP for external CP solvers, catering to various problem-solving needs.</p>
+
+<h3>MetaStrategist (Emerging Technology):</h3>
+<p>In its formative stages, MetaStrategist embodies our pioneering spirit. As a burgeoning meta-solving package, it aims to harness the strengths of CP and JuMP. Its vision is to formulate tailored strategies that consider the unique hardware and software resources at hand, offering a new horizon in problem-solving efficiency and adaptability.</p>
+
+<h3>Performance Checker (Community Resource):</h3>
+<p>PerfChecker.jl transcends its role within Julia Constraints, offering its capabilities to the broader Julia package ecosystem. This indispensable tool for cross-version performance checking not only safeguards the high efficiency and reliability of our packages but also serves the wider community. By facilitating clear and simple performance evaluations, PerfChecker.jl enhances both development and maintenance, contributing to the overall health and progress of Julia's growing library of resources.</p>
 
-I really wonder!
+<p>At Julia Constraints, our mission is to democratize Constraint Programming by providing robust, user-friendly tools that simplify the modeling process, enhance efficiency, and empower users to solve complex problems with ease.</p>
 
-</div>
+</div>
diff --git a/docs/src/compositional_networks.md → docs/src/learning/compositional_networks.md b/docs/src/compositional_networks.md → docs/src/learning/compositional_networks.md
diff --git a/docs/src/constraint_learning.md → docs/src/learning/constraint_learning.md b/docs/src/constraint_learning.md → docs/src/learning/constraint_learning.md
diff --git a/docs/src/qubo_constraints.md → docs/src/learning/qubo_constraints.md b/docs/src/qubo_constraints.md → docs/src/learning/qubo_constraints.md
diff --git a/docs/src/meta_strategist.md → docs/src/meta/meta_strategist.md b/docs/src/meta_strategist.md → docs/src/meta/meta_strategist.md
diff --git a/docs/src/benchmark_ext.md → docs/src/perf/benchmark_ext.md b/docs/src/benchmark_ext.md → docs/src/perf/benchmark_ext.md
diff --git a/docs/src/perf_checker.md → docs/src/perf/perf_checker.md b/docs/src/perf_checker.md → docs/src/perf/perf_checker.md
diff --git a/docs/src/perf_interface.md → docs/src/perf/perf_interface.md b/docs/src/perf_interface.md → docs/src/perf/perf_interface.md
diff --git a/docs/src/cbls.md → docs/src/solvers/cbls.md b/docs/src/cbls.md → docs/src/solvers/cbls.md
diff --git a/docs/src/local_search_solvers.md → docs/src/solvers/local_search_solvers.md b/docs/src/local_search_solvers.md → docs/src/solvers/local_search_solvers.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# The World of Optimization

		Comparison and guidelines about the different way to do optimization.