Skip to content

Commit 38e452d

Browse files
committed
unify docs
1 parent 85af4e4 commit 38e452d

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

docs/pages.jl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
pages = [
2-
"Optimization.jl: A Unified Optimization Package" => "index.md",
1+
pages = ["index.md",
32
"Tutorials" => [
43
"tutorials/intro.md",
54
"tutorials/rosenbrock.md",

docs/src/index.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Optimization.jl
1+
# Optimization.jl: A Unified Optimization Package
22

33
Optimization.jl is a package with a scope that is beyond your normal global optimization
44
package. Optimization.jl seeks to bring together all of the optimization packages
@@ -14,13 +14,28 @@ Assuming that you already have Julia correctly installed, it suffices to import
1414
Optimization.jl in the standard way:
1515

1616
```julia
17-
import Pkg; Pkg.add("Optimization")
17+
import Pkg
18+
Pkg.add("Optimization")
1819
```
1920
The packages relevant to the core functionality of Optimization.jl will be imported
2021
accordingly and, in most cases, you do not have to worry about the manual
2122
installation of dependencies. However, you will need to add the specific optimizer
2223
packages.
2324

25+
## Contributing
26+
27+
- Please refer to the
28+
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
29+
for guidance on PRs, issues, and other matters relating to contributing to SciML.
30+
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
31+
- There are a few community forums:
32+
- The #diffeq-bridged and #sciml-bridged channels in the
33+
[Julia Slack](https://julialang.org/slack/)
34+
- The #diffeq-bridged and #sciml-bridged channels in the
35+
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
36+
- On the [Julia Discourse forums](https://discourse.julialang.org)
37+
- See also [SciML Community page](https://sciml.ai/community/)
38+
2439
## Overview of the Optimizers
2540

2641
| Package | Local Gradient-Based | Local Hessian-Based | Local Derivative-Free | Local Constrained | Global Unconstrained | Global Constrained |

0 commit comments

Comments
 (0)