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: Add links and more discussion to examples. #227

Merged
merged 7 commits into from
Jun 23, 2024

Conversation

eliotwrobson
Copy link
Collaborator

@eliotwrobson eliotwrobson commented Jun 11, 2024

@caleb531 Resolves #226 and adds links to examples and the front page as requested in #212. I think this adds enough additional discussion that we can close #212, as this adds links to other pages and lecture notes that cover the theory in detail.

However, we will still add the planned notebooks with extended teaching examples, likely to their own section on the docs site.

Responding to items on pyOpenSci/software-submission#152

@coveralls
Copy link

Coverage Status

coverage: 99.613%. remained the same
when pulling 1cb6622 on eliotwrobson:more_docs_changes
into 6246b26 on caleb531:develop.

2 similar comments
@coveralls
Copy link

Coverage Status

coverage: 99.613%. remained the same
when pulling 1cb6622 on eliotwrobson:more_docs_changes
into 6246b26 on caleb531:develop.

@coveralls
Copy link

Coverage Status

coverage: 99.613%. remained the same
when pulling 1cb6622 on eliotwrobson:more_docs_changes
into 6246b26 on caleb531:develop.

@coveralls
Copy link

Coverage Status

coverage: 99.613%. remained the same
when pulling 8f18170 on eliotwrobson:more_docs_changes
into 6246b26 on caleb531:develop.

@caleb531
Copy link
Owner

@eliotwrobson I saw a new commit just now—are you still working on this? Let me know when it's ready for my review and I'll have a look!

@coveralls
Copy link

Coverage Status

coverage: 99.613%. remained the same
when pulling 097dbfd on eliotwrobson:more_docs_changes
into 6246b26 on caleb531:develop.

@eliotwrobson
Copy link
Collaborator Author

@caleb531 just added some finishing touches to the docs based on some additional review comments that came in since this PR was still open. Should be good to review, and once this is merged we should be able to push along the review 👍🏽

docs/index.md Outdated Show resolved Hide resolved
Copy link
Owner

@caleb531 caleb531 left a comment

Choose a reason for hiding this comment

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

@eliotwrobson This looks very good! Added some comments with a few grammatical corrections—apologies if they seem rather nitpicky 😅.

Co-authored-by: Caleb Evans <caleb@calebevans.me>
@eliotwrobson
Copy link
Collaborator Author

@caleb531 no worries, being nitpicky usually pays off when reviewing documentation IMO. I've committed all of your changes, if all looks good I'll go ahead and merge soon!

@coveralls
Copy link

Coverage Status

coverage: 99.613%. remained the same
when pulling 45af6fc on eliotwrobson:more_docs_changes
into 6246b26 on caleb531:develop.

@caleb531
Copy link
Owner

@eliotwrobson Yep, looks great now! Approved!

@eliotwrobson eliotwrobson merged commit 3a8f033 into caleb531:develop Jun 23, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants