Skip to content

Add links to ReadTheDocs and example tutorials#124

Merged
flamingbear merged 4 commits intonasa:mainfrom
sonikaarora:add-documentation-links
Feb 5, 2026
Merged

Add links to ReadTheDocs and example tutorials#124
flamingbear merged 4 commits intonasa:mainfrom
sonikaarora:add-documentation-links

Conversation

@sonikaarora
Copy link
Contributor

@sonikaarora sonikaarora commented Feb 4, 2026

Description

This PR addresses issue #114 by adding links to the ReadTheDocs documentation and real-world example tutorials to improve discoverability for new users.

Fixes #114

Changes Made

Fixes nasa#114

- Added prominent Documentation section with link to ReadTheDocs API docs
- Added Examples & Tutorials section with links to:
  - Local example Jupyter notebooks
  - TEMPO atmospheric data tutorial from ASDC cookbook
  - ICESat-2 tutorial from Openscapes cloud cookbook
- Improves discoverability of documentation and real-world examples for new users
- Updated ICESat-2 link from broken URL to working tutorial
- Changed from earthdata-cloud-cookbook path to correct tutorials path
- Link now points to: https://nasa-openscapes.github.io/tutorials/Harmony.html
- Verified all tutorial links are now working correctly
- Corrected URL to include /earthdata-cloud-cookbook/ in path
- Link now properly resolves to working tutorial page
- Verified URL works: https://nasa-openscapes.github.io/earthdata-cloud-cookbook/tutorials/Harmony.html
- Changed from relative path to full GitHub URL
- Link now works from PR views and all contexts
- Points to: https://github.com/nasa/harmony-py/tree/main/examples
@sonikaarora sonikaarora marked this pull request as ready for review February 4, 2026 05:32
Copy link
Contributor

@chris-durbin chris-durbin left a comment

Choose a reason for hiding this comment

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

Thanks for the updates to the README.

Copy link
Member

@flamingbear flamingbear 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 update.

@flamingbear flamingbear merged commit 47ef068 into nasa:main Feb 5, 2026
6 checks passed
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.

Make visible/findable links to readthedocs documentation, examples

3 participants