docs: refresh README for tools added since last update - #2491
Merged
Conversation
The Repository Structure section still described the repo as docs + protocols + manuals + safety docs, missing everything added over the past year. Adds the pieces that were absent and refreshes Quick Start. - Data Catalogs and Web Tools: docs/histology-explorer/, data-portal/, igv_server/ - Automation: .github/workflows/ (Pages deploy, 15-min server probe, URL checker), .github/ISSUE_TEMPLATE/, and scripts/ with a note on why there are two status probers (raven is not in public DNS) - Expand the docs/ bullet to cover onboarding/offboarding, project management, writing and oral presentation guides, agentic coding tools, and the standalone HTML tutorials - Quick Start: add Onboarding, Computing Hardware, and the two data catalogs; point issue reporting at issues/new/choose so the templates are actually used - Note that handbook-navigated protocols live in docs/protocols/, distinct from top-level protocols/ All four new handbook URLs verified to return 200. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
What changed
The README's Repository Structure section still described the repo as
docs/+protocols/+equipment_manuals/+lab_safety_docs/+ two config files. It was missing everything added over the past year. This brings it current.Added — Data Catalogs and Web Tools
docs/histology-explorer/— the Histology Databank Explorer, plus a pointer to its build scripts and READMEdata-portal/— Nightingales sequencing libraries + reference genomes browser, and howbuild.pyregenerates its JSONigv_server/— IGV genome registry and annotation filesAdded — Automation
.github/workflows/— Pages deploy on push tomaster, 15-minute server probe, Markdown URL checker.github/ISSUE_TEMPLATE/scripts/— the status probers, with a one-line note on why there are two of them (raven is not in public DNS, so the in-network cron is the only thing that can see it)Updated
docs/bullet to cover sections that have grown since the last README pass: onboarding/offboarding, project management, writing and oral presentation guides, agentic coding tools, and the standalone HTML tutorialsissues/new/choose— the old bareissues/newlink bypassed the templates in.github/ISSUE_TEMPLATE/docs/protocols/, distinct from top-levelprotocols/Notes for reviewers
html/tjgr.markdown(one orphaned file) and the root-levelUW_NWGC_Library_Submission_Form_2019.docx— neither was in the old README either..readthedocs.ymlis described factually rather than as removed. It's still present but pins Python 3.7 while the live site deploys via GitHub Actions, so it may be worth deleting in a separate change if Read the Docs is genuinely no longer in use.🤖 Generated with Claude Code