Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Simplify the introduction page #2395

Merged
merged 1 commit into from
Dec 14, 2020
Merged

[docs] Simplify the introduction page #2395

merged 1 commit into from
Dec 14, 2020

Conversation

odow
Copy link
Member

@odow odow commented Dec 5, 2020

Closes #2394

@codecov
Copy link

codecov bot commented Dec 5, 2020

Codecov Report

Merging #2395 (c6fb391) into master (f47b18c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2395   +/-   ##
=======================================
  Coverage   91.61%   91.61%           
=======================================
  Files          42       42           
  Lines        4451     4451           
=======================================
  Hits         4078     4078           
  Misses        373      373           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f47b18c...c6fb391. Read the comment docs.

@odow odow requested a review from blegat December 6, 2020 00:20
@odow odow requested a review from mlubin December 14, 2020 23:11

## Resources for getting started

* Checkout the [Installation Guide](@ref).
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps a TODO: I think it would be useful to have a page that explains the concept of an algebraic modeling language and what JuMP does do and doesn't do. The documentation is missing this kind of summary that would help people decide if they want to use JuMP or not. Jumping straight to the installation guide is making an assumption that somewhat has already decided to install JuMP, but maybe they're browsing the documentation to decide if they want to install JuMP.

Copy link
Member Author

Choose a reason for hiding this comment

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

Opened an issue #2412

@odow odow merged commit 47c4a32 into master Dec 14, 2020
@odow odow deleted the od/intro branch December 14, 2020 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Table of content
2 participants