docs: fill in remaining holes in docs #70
+571
−291
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
Member
Done |
korikuzma
requested changes
Jan 23, 2026
| make up-dev | ||
|
|
||
| # Or production mode | ||
| ANYVLM_VERSION=latest make up |
Member
There was a problem hiding this comment.
Don't need ANYVLM_VERSION for prod
Suggested change
| ANYVLM_VERSION=latest make up | |
| make up |
|
|
||
| .. code-block:: console | ||
|
|
||
| % docker compose -f compose.dev.yaml -f compose.anyvar.yaml up --build |
Member
There was a problem hiding this comment.
When using docker commands directly instead of make shortcuts, we have to set ANYVLM_VERSION
Suggested change
| % docker compose -f compose.dev.yaml -f compose.anyvar.yaml up --build | |
| % ANYVLM_VERSION=0.0.0 docker compose -f compose.dev.yaml -f compose.anyvar.yaml up --build |
|
|
||
| % docker compose -f compose.dev.yaml -f compose.anyvar.yaml up --build | ||
|
|
||
| Once the containers are running, visit `http://127.0.0.1:8080/docs <http://127.0.0.1:8080/docs>`_ to view the interactive Swagger UI and confirm the service is responding. |
Member
There was a problem hiding this comment.
Suggested change
| Once the containers are running, visit `http://127.0.0.1:8080/docs <http://127.0.0.1:8080/docs>`_ to view the interactive Swagger UI and confirm the service is responding. | |
| Once the containers are running, visit `http://127.0.0.1:8080<http://127.0.0.1:8080>`_ to view the interactive Swagger UI and confirm the service is responding. |
|
|
||
| At present, AnyVLM serves `Cohort Allele Frequency (CAF) <https://va-spec.ga4gh.org/en/1.0/va-standard-profiles/base-profiles/study-result-profiles.html#cohort-allele-frequency-study-result>`_ objects, describing the frequency of an allele in a cohort. CAF objects may also report additional data, including frequency broken down by zygosity and quality control filters declared by the original variant calls. | ||
|
|
||
| .. figure:: /_static/img/caf.png |
Member
There was a problem hiding this comment.
Should we reference https://gnomad.broadinstitute.org/news/2023-11-ga4gh-gks/ ?
| This version of AnyVLM validates data using the following data standards: | ||
|
|
||
|
|
||
| .. list-table:: |
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.
close #25
Viewable here: https://anyvlm--70.org.readthedocs.build/en/70/
@korikuzma to add github changelog API token as env var where needed if it's not already there