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

User Guide & Documentation Improvements #472

Merged
merged 98 commits into from
May 13, 2024
Merged

User Guide & Documentation Improvements #472

merged 98 commits into from
May 13, 2024

Conversation

philipc2
Copy link
Member

@philipc2 philipc2 commented Sep 22, 2023

Closes #473

Overview

  • Introduces a the User Guide section to our documentation
  • Updated the front page with new descriptions and references to the Contributors Guide and User Guide

Updated Front Page

image

@philipc2 philipc2 changed the title Add User Guide DRAFT: Add User Guide Sep 22, 2023
@UXARRAY UXARRAY deleted a comment from review-notebook-app bot Sep 22, 2023
@philipc2 philipc2 linked an issue Oct 4, 2023 that may be closed by this pull request
@philipc2 philipc2 self-assigned this Oct 4, 2023
@philipc2 philipc2 added the documentation Improvements or additions to documentation label Oct 25, 2023
@philipc2 philipc2 mentioned this pull request Oct 30, 2023
10 tasks
@philipc2 philipc2 changed the title DRAFT: User Guide & Documentation Improvements User Guide & Documentation Improvements May 7, 2024
@philipc2 philipc2 marked this pull request as ready for review May 7, 2024 20:32
Copy link
Collaborator

@hongyuchen1030 hongyuchen1030 left a comment

Choose a reason for hiding this comment

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

good work! I wonder if we can add some pictures as illustrations in the User Guid/Terminology section?

Also some introduction for our constants will be helpful as well

@rajeeja
Copy link
Contributor

rajeeja commented May 7, 2024

Also some introduction for our constants will be helpful as well

constants intro is more of a subject for the developers guide

@hongyuchen1030
Copy link
Collaborator

Also some introduction for our constants will be helpful as well

constants intro is more of a subject for the developers guide

There are still some useful constants for the users.

For example, when the users are using our package, knowing what's the smallest value for the relative error tolerance is also important.

@philipc2
Copy link
Member Author

philipc2 commented May 7, 2024

@hongyuchen1030

We can add a section once this is merged on the accuracy of our operators, including discussions on the expected error.

@philipc2 philipc2 merged commit e7d0972 into main May 13, 2024
14 checks passed
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

Successfully merging this pull request may close these issues.

Set up User Guide section in Documentation
4 participants