{"id":30858606,"url":"https://github.com/pkgw/onegoodtutorial","last_synced_at":"2026-02-18T05:15:57.429Z","repository":{"id":312295329,"uuid":"1046990853","full_name":"pkgw/onegoodtutorial","owner":"pkgw","description":"The onegoodtutorial.org website","archived":false,"fork":false,"pushed_at":"2026-02-12T21:28:40.000Z","size":742,"stargazers_count":13,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-13T00:55:33.851Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pkgw.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-29T14:59:08.000Z","updated_at":"2026-02-12T21:25:44.000Z","dependencies_parsed_at":"2025-08-29T18:44:21.037Z","dependency_job_id":"2e33c383-4370-49e0-92cf-8956fdf673f6","html_url":"https://github.com/pkgw/onegoodtutorial","commit_stats":null,"previous_names":["pkgw/onegoodtutorial"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/pkgw/onegoodtutorial","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fonegoodtutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fonegoodtutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fonegoodtutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fonegoodtutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pkgw","download_url":"https://codeload.github.com/pkgw/onegoodtutorial/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fonegoodtutorial/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29569856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T04:18:28.490Z","status":"ssl_error","status_checked_at":"2026-02-18T04:13:49.018Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-07T14:14:54.176Z","updated_at":"2026-02-18T05:15:52.413Z","avatar_url":"https://github.com/pkgw.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# One Good Tutorial\n\nThis is the repo for [onegoodtutorial.org]!\n\n[onegoodtutorial.org]: https://onegoodtutorial.org/\n\n[**One Good Tutorial**](https://onegoodtutorial.org/) is a resource for people\nwho are documenting scientific software. The main idea is right there in the\nname: the most important thing is that your software’s documentation includes\n*one good tutorial*. You need a bit more than that, but not much more: the [One\nGood Tutorial software documentation checklist](https://onegoodtutorial.org/)\ndefines nine core elements of scientific software documentation. The resource\nalso includes [a playbook](https://onegoodtutorial.org/playbook/) you can follow\nto prepare these nine elements with a minimum of angst and a number of\nsupporting [in-depth guides](https://onegoodtutorial.org/in-depth/).\n\nVisit [onegoodtutorial.org] for all the details. The [About page][about] has\ninformation about the One Good Tutorial project itself.\n\n[about]: https://onegoodtutorial.org/about/\n\n\n## Legalities\n\n[One Good Tutorial](https://onegoodtutorial.org/) © 2025–2026 by [Peter K. G.\nWilliams](https://newton.cx/~peter/) is licensed under [CC BY-SA\n4.0](https://creativecommons.org/licenses/by-sa/4.0/).\n\n\n## Acknowledgments\n\nThis work was supported by the [Better Scientific Software Fellowship\nProgram](https://bssw.io/pages/bssw-fellowship-program), a collaborative effort\nof the [U.S. Department of Energy (DOE)](https://www.energy.gov/), Office of\nAdvanced Scientific Computing Research via [ANL](https://www.anl.gov/) under\nContract\n[DE-AC02-06CH11357](https://www.usaspending.gov/award/CONT_AWD_DEAC0206CH11357_8900_-NONE-_-NONE-)\nand the National Nuclear Security Administration [Advanced Simulation and\nComputing Program](https://asc.llnl.gov/) via [LLNL](https://www.llnl.gov/)\nunder Contract\n[DE-AC52-07NA27344](https://www.usaspending.gov/award/CONT_AWD_DEAC5207NA27344_8900_-NONE-_-NONE-);\nand by the [National Science Foundation (NSF)](https://www.nsf.gov/) via\n[SHI](https://shinstitute.org/) under Grant No.\n[2435328](https://www.nsf.gov/awardsearch/show-award?AWD_ID=2435328).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpkgw%2Fonegoodtutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpkgw%2Fonegoodtutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpkgw%2Fonegoodtutorial/lists"}