docs: teach search all as the unified cross-entity discovery entry point#190
Merged
docs: teach search all as the unified cross-entity discovery entry point#190
Conversation
… docs/index Add search all to the Quick start and Command grammar sections of both README.md and docs/index.md so first-contact newcomer docs reflect the unified cross-entity discovery workflow. Add focused docs-contract tests to guard against future drift of this framing.
7 tasks
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.
Summary
search allto the## Quick startand## Command grammarsections of bothREADME.mdanddocs/index.mdbiomcp search all --gene BRAF --disease melanoma) so first-contact newcomer docs reflect the unified discovery workflowtests/test_public_search_all_docs_contract.py) to guard these sections against future driftWhy
The top-level newcomer surfaces (
README.mdanddocs/index.md) previously omittedsearch allfrom the quick-start framing and command grammar overview. New users reading those pages would see onlyhealth,list, and entity-specific commands — leaving BioMCP's primary cross-entity discovery entry point undiscoverable until they dug into the CLI reference.The CLI reference and functional overview already document
search allas the unified fan-out command. This change brings the high-traffic landing pages into alignment with that framing.Changes
README.md: two-line addition to Quick start and Command grammar sectionsdocs/index.md: same two-line addition mirroredtests/test_public_search_all_docs_contract.py: section-scoped assertions that fail if either newcomer surface drops thesearch allframing again