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

Doc/restructuring general tutorial #514

Merged
merged 34 commits into from
Sep 5, 2023

Conversation

chadcwilliams
Copy link
Collaborator

Description

Restructured the main introductory tutorial by splitting it into four notebooks for easier consumption. I have also edited the notebooks.

If the issue is on Github, simply link to it using the '#' symbol; otherwise, provide a notion page link):

Type of change

  • refactor: A code change that neither fixes a bug nor adds a feature
  • docs: Documentation only changes

Remarks (Optional)

  • In each notebook, there are links to each other notebook. I'll need to check the links to make sure they are good.

mkdocs.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

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

building of website fails. This should fix it

Co-authored-by: Younes Strittmatter <[email protected]>
Copy link
Collaborator

@musslick musslick left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for the restructuring!

Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

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

looks good

Copy link
Member

@hollandjg hollandjg left a comment

Choose a reason for hiding this comment

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

Looks great!

@hollandjg
Copy link
Member

Looks like it wasn't passing the pre-commit checks. You should run pre-commit install so that the notebook clean-up hook runs when you commit. You can check that everything is "clean" by running pre-commit run --all-files in your copy of the repository. I ran the hooks on the notebooks (didn't make any other changes though), so you should be good to merge now.

@chadcwilliams
Copy link
Collaborator Author

Re-implemented with the latest AutoRA versions. However, the latest AutoRA is not yet stable, so this will need to be updated again once AutoRA is stable.

@chadcwilliams chadcwilliams added this pull request to the merge queue Sep 5, 2023
Merged via the queue into main with commit d5f1979 Sep 5, 2023
@chadcwilliams chadcwilliams deleted the doc/restructuring-general-tutorial branch September 5, 2023 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

General-Tutorial-Restructuring
4 participants