Fix broken README links and document setup (issue #23)#24
Open
lanery wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Fixes documentation link rot and adds a small reproducibility note so readers can follow the README “entry point” without hitting 404s.
Changes:
- Update the README link to the data-loading module to point to
src/analysis/load_spectra.py. - Fix README links to setup and contributing docs by pointing to
pages/SETUP.qmdandpages/CONTRIBUTING.qmd. - Document the OS/hardware context used to develop/test the analysis (macOS, Apple Silicon).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
Addresses the reproducibility review in #23.
SETUP.qmd/CONTRIBUTING.qmdnow point topages/SETUP.qmd/pages/CONTRIBUTING.qmd(previously 404'd on GitHub).load_spectra.pynow points tosrc/analysis/load_spectra.py(removed the erroneous../).Closes #23
Test plan
Made with Cursor