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 updates #293

Merged
merged 10 commits into from
Oct 31, 2023
Merged

Docs updates #293

merged 10 commits into from
Oct 31, 2023

Conversation

DonBraulio
Copy link
Collaborator

@DonBraulio DonBraulio commented Oct 26, 2023

⚠️ This PR changes the path of getting_started guide so git-hooks must be updated:

cp .git-hooks/* .git/hooks

#288 needs to be merged before this (user_guide uses evset.equal()).

Main changes:

  • Many updates to the user_guide to use eager mode.
  • Set getting_started as starting point in the docs, combined the relevant parts of 3_minutes guide (deleted).

@github-actions
Copy link

Coverage report

Main: 90.85% | PR: 90.84% | Diff: -0.01 ⚠️

@google google deleted a comment from github-actions bot Oct 27, 2023
@google google deleted a comment from github-actions bot Oct 27, 2023
@github-actions
Copy link

Coverage report

Main: 90.85% | PR: 90.84% | Diff: -0.01 ⚠️

@ianspektor ianspektor changed the base branch from main to fix-tests-arithm-scalar October 30, 2023 15:29
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/user_guide.ipynb Show resolved Hide resolved
Copy link
Collaborator

@achoum achoum left a comment

Choose a reason for hiding this comment

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

Awesome

@@ -2,7 +2,7 @@
#
files_to_check="docs/src/recipes/*.ipynb"
files_to_check+=" docs/src/user_guide.ipynb"
files_to_check+=" docs/src/tutorials/getting_started.ipynb"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we risk breaking existing url that we shared?

Maybe we can add a redirection from tutorials/getting_started.ipynb to getting_started.ipynb?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good idea, I'll create a symlink and see if it works.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

FYI: symlink didn't work, but I could configure a redirect through the rtd admin panel.

docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
docs/src/getting_started.ipynb Outdated Show resolved Hide resolved
Base automatically changed from fix-tests-arithm-scalar to main October 31, 2023 16:55
Copy link

Coverage report

Main: 90.85% | PR: 90.84% | Diff: -0.01 ⚠️

Copy link

Coverage report

Main: 90.85% | PR: 90.84% | Diff: -0.01 ⚠️

@DonBraulio DonBraulio merged commit 1b6b604 into main Oct 31, 2023
20 checks passed
@DonBraulio DonBraulio deleted the docs-updates branch October 31, 2023 19:15
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.

3 participants