{"id":28545633,"url":"https://github.com/crate/crate-docs","last_synced_at":"2026-05-26T04:39:37.675Z","repository":{"id":38194324,"uuid":"291936843","full_name":"crate/crate-docs","owner":"crate","description":"Common build system, QA tools, style guides, and other meta miscellanies for doing docs at Crate.io.","archived":false,"fork":false,"pushed_at":"2025-09-29T18:15:35.000Z","size":799,"stargazers_count":2,"open_issues_count":19,"forks_count":1,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-09-29T20:30:54.709Z","etag":null,"topics":["build","docs","qa","style-guide"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crate.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.rst","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}},"created_at":"2020-09-01T08:09:36.000Z","updated_at":"2025-09-29T18:15:38.000Z","dependencies_parsed_at":"2024-02-28T17:31:23.618Z","dependency_job_id":"c7ef909b-80e9-49ff-909c-d4aa639d54bf","html_url":"https://github.com/crate/crate-docs","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/crate/crate-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate%2Fcrate-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate%2Fcrate-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate%2Fcrate-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate%2Fcrate-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crate","download_url":"https://codeload.github.com/crate/crate-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate%2Fcrate-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004815,"owners_count":26083783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["build","docs","qa","style-guide"],"created_at":"2025-06-09T23:08:16.070Z","updated_at":"2025-10-10T17:10:49.021Z","avatar_url":"https://github.com/crate.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"============================\nCrateDB Documentation System\n============================\n\n|version| |ci| |rtd|\n\nBuild system, authoring, and QA tools, and a style guide for the\n`CrateDB documentation`_.\n\n\n🧐 What's Inside\n================\n\n-   **docs** contains an example documentation instance for demonstration\n    purposes.\n\n-   **style** contains the CrateDB style guide.\n\n-   The **tasks.py** file includes tooling to support operations\n    in tech writing.\n\n-   The **registry** folder includes the `github-projects.txt`_ and `sphinx-inventories.txt`_\n    files, which enumerate all repositories and target URLs that resemble\n    the documentation at https://cratedb.com/docs/.\n\n\nUsage\n=====\n\n🍀 Tools\n--------\n\nA few operational tasks are defined within the top-level ``tasks.py`` file.\nAfter setup::\n\n    git clone https://github.com/crate/crate-docs\n    cd crate-docs\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip install -r requirements.txt\n\nyou can display a list of available tasks using::\n\n    invoke --list\n\nThere is also tooling to support `Technical Writing on HubSpot`_.\n\n🔗 Intersphinx\n--------------\n\nFor displaying intersphinx_ inventories to learn about available link targets,\nrun commands like this::\n\n    invoke inv https://cratedb.com/docs/crate/reference/en/latest/objects.inv\n    invoke allinv --format=markdown\n    invoke allinv --format=html+table\n\n\nContributing\n============\n\nThis project is primarily maintained by `Crate.io`_, but we welcome community\ncontributions!\n\nSee the `developer docs`_ and `contributor docs`_ for more information.\n\n\nHelp\n====\n\nLooking for more help?\n\n- Check out our `support channels`_\n- Read our `Code of Conduct`_\n\n\n.. |version| image:: https://img.shields.io/endpoint.svg?color=blue\u0026label=docs%20build%20version\u0026url=https://raw.githubusercontent.com/crate/crate-docs/main/docs/build.json\n    :alt: Build version\n    :target: https://github.com/crate/crate-docs/blob/main/docs/build.json\n\n.. |ci| image:: https://github.com/crate/crate-docs/workflows/docs/badge.svg\n    :alt: CI status\n    :target: https://github.com/crate/crate-docs/actions/workflows/docs.yml\n\n.. |rtd| image:: https://readthedocs.org/projects/crate-docs/badge/?version=latest\n    :alt: Read The Docs status\n    :target: https://readthedocs.org/projects/crate-docs\n\n\n.. _Code of Conduct: CONTRIBUTING.rst\n.. _contributor docs: CONTRIBUTING.rst\n.. _Crate.io: https://cratedb.com/\n.. _CrateDB documentation: https://cratedb.com/docs/\n.. _developer docs: DEVELOP.rst\n.. _github-projects.txt: registry/github-projects.txt\n.. _intersphinx: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html\n.. _Sphinx: http://www.sphinx-doc.org/en/stable/\n.. _sphinx-inventories.txt: registry/sphinx-inventories.txt\n.. _support channels: https://cratedb.com/support/\n.. _Technical Writing on HubSpot: https://github.com/crate-workbench/hubspot-tech-writing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrate%2Fcrate-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrate%2Fcrate-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrate%2Fcrate-docs/lists"}