Skip to content

Draft: MkDocs documentation site#19

Open
Dahlializi wants to merge 15 commits intomainfrom
docs
Open

Draft: MkDocs documentation site#19
Dahlializi wants to merge 15 commits intomainfrom
docs

Conversation

@Dahlializi
Copy link
Collaborator

No description provided.

@Dahlializi Dahlializi marked this pull request as ready for review November 22, 2025 01:26
@Dahlializi Dahlializi assigned Dahlializi and unassigned Dahlializi Nov 22, 2025
@thompsonmj thompsonmj marked this pull request as draft January 30, 2026 16:35
@thompsonmj
Copy link
Contributor

The site may be previewed from this PR at:
https://imageomics.github.io/TaxonoPy/pr-19/

@thompsonmj
Copy link
Contributor

To view the current preview, you might need to refresh browser cache.

@thompsonmj thompsonmj assigned jjivandas and unassigned jjivandas Feb 13, 2026
@thompsonmj thompsonmj requested a review from jjivandas February 13, 2026 15:31
@thompsonmj thompsonmj marked this pull request as ready for review February 13, 2026 15:31
@thompsonmj
Copy link
Contributor

The primary goal of the quick reference guide and scaffolding for other documentation pages are in place, and I think ready to merge to go live.

For work that @Dahlializi is still doing on contributing guidelines, that local work can be moved to a new branch off main once this is merged in to keep scope here modest.

See https://imageomics.github.io/TaxonoPy for documentation on installation, usage, and more.

## Development
See the [Wiki Development Page](https://github.com/Imageomics/TaxonoPy/wiki/Development) for development instructions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this is going to be moved to the Development section of the MkDocs site in a later PR?

Copy link
Member

@egrace479 egrace479 Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice to keep some of the description in the README, or at least a paired-down version. Could be just:

TaxonoPy (taxon-o-py) is a command-line tool for creating an internally consistent taxonomic hierarchy using the Global Names Verifier (gnverifier).

followed by the see the docs link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants