Repository navigation
Simplify docs home and organize guides by common tasks - #439
Merged
Merged
Conversation
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
1 participant
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.
The documentation home page required another click before readers could install the package or try a query, and the guides led with uncommon dataset choices. Put installation, TP53 lookup, real transcript/protein sequence excerpts and output interpretation together on home.
Order navigation by common tasks first (genes/transcripts, aliases and genomic DNA), followed by reference selection, downloads and custom annotations. Collapse sidebar groups and use task names. Rewrite the gene/transcript guide around name, ID and genomic-position lookups on the same human release 93 dataset; move fly and older HLA-A examples to the end. Keep scientific qualifications and complete API coverage. README links now open the rendered site.
Preserve the old getting-started URL with a standard MkDocs redirect, including all five section fragments, and retain a short source-page link for old GitHub URLs. Update contributor guidance to keep first results on home and organize guides around reader workflows.
Fix the arbitrary first-name-match DNA example (#437) with a stable TP53 ID. Fix the example checker consuming prose after unpaired code blocks (#438), and check all five home/common-query outputs. Validate README links to the generated site as well as source files.
Validation: ./docs.sh passed (22 pages, rendered internal links and anchors, README destinations and complete exported API coverage); all five examples matched installed human GRCh38 / Ensembl 93. Old tutorial redirect/fragment verified in a browser. Home, common-query guide and Genome API reviewed at desktop (1280 px) and narrow (390 px) widths without page-wide overflow. ./lint.sh and TEST_SH_MAX=2 ./test.sh passed (527 passed, 1 opt-in benchmark skipped). Version: 2.22.3.
Closes #437.
Closes #438.
CI infrastructure note: the strict documentation build and Python 3.9 job passed on GitHub. The remaining matrix jobs were cancelled before any steps ran because hosted runners could not be assigned, matching the ongoing https://www.githubstatus.com/ Actions incident. The PR's 527-test suite passed locally. The documentation/example checker changes were also exercised in the HGNC follow-up candidate on local Python 3.9–3.14: lint, all 538 tests (one opt-in benchmark skipped), and all five documented examples passed on each version. No required status check is configured on main. Clean-main deployment will run the ordinary lint/test gates.