docs: fix README usage path, typos, and doc links#123
Merged
ChrisBarker-NOAA merged 2 commits intoioos:mainfrom Apr 5, 2026
Merged
docs: fix README usage path, typos, and doc links#123ChrisBarker-NOAA merged 2 commits intoioos:mainfrom
ChrisBarker-NOAA merged 2 commits intoioos:mainfrom
Conversation
- Point example notebooks to docs/examples on GitHub and RTD - Fix interpreted typo and venv activate path for Unix - Add Windows venv activation hints and numpy import in snippet Made-with: Cursor
Contributor
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only updates to the project README so the quickstart matches the real repo layout and matches how people set up a venv on common platforms.
Changes
Fix the “example notebooks” pointer: notebooks live under docs/examples, with links to the GitHub tree and the published Sphinx docs on Read the Docs.
Correct the “interpreted” typo and the Unix venv activation line (venv/bin/activate).
Add short Windows activation notes (cmd + PowerShell).
Add import numpy as np to the usage snippet so it runs when copied as-is.
Motivation
Low-friction onboarding for contributors (including GSoC applicants) and fewer broken paths in the first thing new users read.
Testing
Not applicable (Markdown only).