{"id":26228975,"url":"https://github.com/zefhub/zef-docs","last_synced_at":"2026-04-25T13:39:22.067Z","repository":{"id":43020127,"uuid":"319593543","full_name":"zefhub/zef-docs","owner":"zefhub","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-13T05:07:04.000Z","size":28339,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-12-29T12:25:04.859Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://zef-docs.vercel.app","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zefhub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-12-08T09:46:50.000Z","updated_at":"2023-02-27T04:45:30.000Z","dependencies_parsed_at":"2025-03-12T21:48:43.650Z","dependency_job_id":null,"html_url":"https://github.com/zefhub/zef-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zefhub/zef-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zefhub%2Fzef-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zefhub%2Fzef-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zefhub%2Fzef-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zefhub%2Fzef-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zefhub","download_url":"https://codeload.github.com/zefhub/zef-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zefhub%2Fzef-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32264431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T09:15:33.318Z","status":"ssl_error","status_checked_at":"2026-04-25T09:15:31.997Z","response_time":59,"last_error":"SSL_read: 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-03-12T21:36:48.070Z","updated_at":"2026-04-25T13:39:22.037Z","avatar_url":"https://github.com/zefhub.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZefDB Docs\n\n[This approach and talk](https://documentation.divio.com/) largely influenced the structure of this documentation.\n\nBelow is a proposal for how the ZefDB docs can be organized:\n\n- Quickstart: step-by-step instructions to help new users get ZefDB (and ZefHub) up and running\n- Tutorials: bite-sized end-to-end projects to help users learn new ways of using ZefDB\n- How-to: step-by-step instructions answering a specific question or solving a common problem\n- Reference: descriptions of each individual ZefDB \"user tool\" without any extended explanations or justifications\n- Discussions: additional links for bug reporting and feature roadmaping\n\nThe above is designed for if/when ZefDB is full-fledged open source.\n\nThe current iteration of documents is designed for the very earliest private alpha test users, assuming they go through a guided demo and environment setup.\n\n## Getting started\n\n- Install Docusaurus:\n  ```console\n  yarn install\n  ```\n\n- Build the website for development:\n  ```console\n  yarn start\n  ```\n  This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n- Build the website for deployment:\n  ```console\n  yarn build\n  ```\n  Pushing to the `master` branch triggers a GitHub action which executes `yarn build` and deploys the updated website to `docs.zefdb.com`. `build` performs additional consistency checks compared to `start`, hence it is a good idea to run `yarn build` locally before pushing. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzefhub%2Fzef-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzefhub%2Fzef-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzefhub%2Fzef-docs/lists"}