docs: the published package list pointed users at archived repositories - #33
Open
belkassaby wants to merge 1 commit into
Open
belkassaby wants to merge 1 commit into
belkassaby wants to merge 1 commit into
Conversation
`docs/reference/available-packages.md` is on the public docs site and advertised every GeneWeaver package as having "its own documentation and code repository". That is no longer true: core, db, client and tools are developed in this monorepo under `packages/`, and the standalone repositories for db, client, tools, testing and boolean-algebra are archived on GitHub. Most misleading was `geneweaver-tools`. The published package contains the `AbstractTool` framework only -- the archived repo has nothing under `src/geneweaver/tools/` except `framework/` -- while the nine ported analysis tools live here in `packages/tools` and are unpublished. A reader following that link to run GeneWeaver tools would find no tools. Keeps the PyPI links, which are still valid install targets, and names which repositories are archived rather than implying all of them are (`geneweaver-core`'s is not).
This branch has not been deployed
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.
The problem
docs/reference/available-packages.mdis published on the docs site (mkdocs nav, "Reference → Available Packages") and told readers:That is no longer true. Checked each repo with
gh:geneweaver-coregeneweaver-dbgeneweaver-clientgeneweaver-toolsgeneweaver-testinggeneweaver-boolean-algebraCore, db, client and tools are developed here under
packages/; five of the six standalone repos are archived.Why
geneweaver-toolsis the sharpest caseThe page describes it as "a framework for creating analysis tools" and links to PyPI. The archived repo at
0.0.5contains onlysrc/geneweaver/tools/framework/—abstract.py,enum.py,schema.py— and no tool implementations at all.The nine ported analysis tools (BooleanAlgebra, Combine, DBSCAN, HyperGeometric, JaccardClustering, JaccardSimilarity, MSET, PhenomeMap, UpSet) live in this monorepo at
packages/tools(0.20.0a0) and are unpublished. A reader following that link expecting to run GeneWeaver's analysis tools finds none of them.The change
One admonition after the package list. Deliberately conservative:
pip install geneweaver-clientis the recommended path for researchers further down the same page.geneweaver-core's is not.Left alone: the two mermaid diagrams. The relationship graph is arguably stale too (it shows
geneweaver-boolean-algebrafeeding the application, whereas it is now a plugin dependency of the AsyncTask service), but redrawing it is an editorial call rather than a factual fix, and I did not want to bundle it.Verification
mkdocs build --strictexits 0 with zero warnings.Related
Separate from #32 (AsyncTask plugin registration), which touches
docs/tools/TOOLS_MIGRATION.mdbut not this page. Two findings worth flagging that are not addressed here:geneweaver-testingis archived, yet it is still a live dev dependency of this repo ([dependency-groups] dev = ["geneweaver-testing>=0.1.2"], resolved from PyPI, not the workspace).geneweaver-boolean-algebrais archived, yet the AsyncTask service still depends on0.3.0a23. That is useful input to the open question of whether it orpackages/tools' BooleanAlgebra is authoritative.