Skip to content

Add Translator Guide and improve README for issue #133#262

Draft
gaurav wants to merge 2 commits intomainfrom
improve-documentation
Draft

Add Translator Guide and improve README for issue #133#262
gaurav wants to merge 2 commits intomainfrom
improve-documentation

Conversation

@gaurav
Copy link
Copy Markdown
Collaborator

@gaurav gaurav commented Apr 27, 2026

Creates documentation/TranslatorGuide.md with Translator-specific guidance: what to do when lookup results are unexpected (highlighting, type/prefix/taxa filters, autocomplete), when to use /synonyms vs. NodeNorm, and performance tips (bulk-lookup, filtering, caching).

Updates README.md with a Colab badge link to the notebook and a structured Getting Started / Documentation section layout.

Closes #133

Creates documentation/TranslatorGuide.md with Translator-specific
guidance: what to do when lookup results are unexpected (highlighting,
type/prefix/taxa filters, autocomplete), when to use /synonyms vs.
NodeNorm, and performance tips (bulk-lookup, filtering, caching).

Updates README.md with a Colab badge link to the notebook and a
structured Getting Started / Documentation section layout.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix typo and improve conflation paragraph in openapi.yml; update Babel
  Conflation.md link from master to main
- Add conflations list and conflation_url to /status response, driven by
  a CONFLATIONS env var (default: GeneProtein,DrugChemical) so each
  deployment can self-describe
- Fix incomplete sentence and improve conflation section in API.md; add
  new /status fields to example response
- Add /status to the quick decision table in TranslatorGuide.md

Closes #202

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Update NameLookup Jupyter Notebook and write some Translator-specific documentation

1 participant