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

Add FAQ Section to Docs #217

Open
pulsipher opened this issue Feb 8, 2022 · 2 comments
Open

Add FAQ Section to Docs #217

pulsipher opened this issue Feb 8, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@pulsipher
Copy link
Collaborator

Following #213, we should had a FAQ page in the documentation that addresses a number of common questions that common in domain specific areas (e.g., optimal control).

It might also be a good idea to create a terminology table to equate domain specific terms to our unifying abstraction.

@pulsipher pulsipher added the documentation Improvements or additions to documentation label Feb 8, 2022
@pulsipher pulsipher added this to the v0.6 milestone Feb 8, 2022
@SalmanRashid1979
Copy link

Hi @pulsipher I am a technical writer looking to contribute to open source projects on GitHub. I am new to Github and was wondering if you'd like my help with this. Give me a shout if you do 😊

@pulsipher
Copy link
Collaborator Author

Pull requests are more than welcome. Please review our docs on contributing to learn more: https://pulsipher.github.io/InfiniteOpt.jl/stable/develop/start_guide/.

For the particulars of this addition, I can jot down some FAQs later as a starting point. Note, I foresee this following a tutorial type format so it will require familiarity with the API and existing documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants