Skip to content

Fixes formatting. #2

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixes formatting. #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions website_plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Web design for applied math open-source software project
Web design for applied math open-source software project

Essential information
--------------------

## Essential information

Project scope: We’re looking for someone to revamp the online documentation and welcome page at cvxpy.org.

Budget: We received a $4k grant from a nonprofit to get this work done.
Expand All @@ -15,8 +16,8 @@ Required skillset:
Optional, but appreciated, skillset:
* Some background in math

## Where we are and where we want to be

Where we are and where we want to be
----------------------------------
CVXPY focuses entirely on a type of optimization known as “convex optimization.” It has made major strides in democratizing the use of this type of optimization across scientific and engineering fields. Much of this success can be attributed to the quality of CVXPY's web documentation in its early years. However, many features have been added to CVXPY since the website was last designed. As a result, our web documentation has become hard for new users to navigate. At the same time, we have longstanding users (e.g., in industry and at national labs) who have a hard time learning about our most advanced capabilities.

Our current website is built with a basic sphinx template. Notably, it lacks the interactivity required to curate information to different users. We would like you to help modernize our website to present information at different levels of granularity without having to rely solely on different levels of "headings" in a long web page. One example is in information about the wide range of third-party libraries that CVXPY relies on for the actual numerical optimization process. This information is currently contained in the "Advanced Features" section of the documentation [1], which houses many unrelated topics and thus would greatly benefit from a more flexible structure.
Expand All @@ -27,7 +28,8 @@ Another place where we need to improve the presentation of information is in the
[2] https://www.cvxpy.org/tutorial/functions/index.html


## How to apply
How to apply
-----------------

Email us at [email protected] with the following:
* Your portfolio/links to sites you’ve made in the past
Expand Down