Repository navigation
Tskit and C #325
Description
As we have a "tskit and R" tutorial, I think it would be helpful to have a "tskit and C" equivalent too. It can be a summary page that mostly points to https://tskit.dev/tskit/docs/stable/c-api.html, but also mentions the examples in e.g. https://github.com/tskit-dev/tskit/blob/main/c/examples/multichrom_wright_fisher.c which are currently not very visible.
No need to make it too long.
Activity
bhaller commentedon Jul 8, 2026
As I wrote in Slack:
gregorgorjanc commentedon Jul 8, 2026
Hmm, isn't https://tskit.dev/tskit/docs/stable/c-api.html sufficient? I have found it very informative when I started work with
RcppTskit. It also shows extensive examples https://tskit.dev/tskit/docs/stable/c-api.html#examples (should https://github.com/tskit-dev/tskit/blob/main/c/examples could be made (more?) prominent in the examples section?).You could only link "Tskit and C" to C API directly at https://tskit.dev/tskit/docs/stable/c-api.html sufficient.
Alternatively, make a stub "tutorial" page saying that
tskit C APIis covered extensively at https://tskit.dev/tskit/docs/stable/c-api.html sufficientbhaller commentedon Jul 8, 2026
Yes, that's what I was looking for! :-> Google doesn't seem to index it, or at least I couldn't get a google search that would bring it up. And I couldn't find a link to any of that from https://tskit.dev/learn/; I was looking at the "tutorials" tab there, and wondering, "where are the examples??" I knew the page I wanted existing, but I couldn't figure out how to get there, since tskit.dev didn't seem to link to it, and Google wouldn't give it to me. Does https://tskit.dev/learn/ link to the doc at all? Anyhow, something needs to get linked up more, somehow, but I'll leave it to @hyanwong to figure out what the best solution is. :->
bhaller commentedon Jul 8, 2026
Ah, if I got to https://tskit.dev/software/ then I could get to https://tskit.dev/tskit/docs/ from there, and then find the examples. I guess "examples" don't seem that different from "tutorials" to me, at some level, and "doc" should be linked to from "learn" as well as from "software", perhaps. But regardless of all this, orthogonally, it is puzzling that Google wouldn't give me the page with searches like "tskit multithreaded simplification". For some reason, Google doesn't like those pages, it seems like. Mysterious. Maybe we need a little SEO (which I know nothing about).