{"id":21170066,"url":"https://github.com/covenantsql/docs","last_synced_at":"2025-07-09T19:32:21.187Z","repository":{"id":43593574,"uuid":"162449779","full_name":"CovenantSQL/docs","owner":"CovenantSQL","description":"CovenantSQL docs","archived":false,"fork":false,"pushed_at":"2023-02-28T18:30:48.000Z","size":5871,"stargazers_count":4,"open_issues_count":18,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-08-13T05:10:41.636Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://developers.covenantsql.io","language":"JavaScript","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/CovenantSQL.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}},"created_at":"2018-12-19T14:35:31.000Z","updated_at":"2023-02-03T18:10:38.000Z","dependencies_parsed_at":"2023-02-01T10:46:47.413Z","dependency_job_id":null,"html_url":"https://github.com/CovenantSQL/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CovenantSQL%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CovenantSQL%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CovenantSQL%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CovenantSQL%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CovenantSQL","download_url":"https://codeload.github.com/CovenantSQL/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225587778,"owners_count":17492632,"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","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":"2024-11-20T15:55:54.866Z","updated_at":"2024-11-20T15:55:55.498Z","avatar_url":"https://github.com/CovenantSQL.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CovenantSQL Docs\nDocumentation of CovenantSQL and related tools, build with [Docusaurus](https://github.com/facebook/Docusaurus).\n\n## Docs update\n### docs\nUpdate markdown docs in `/docs` folder, and make sure every doc file has the header\nstructure as following:\n```\n---\nid: $doc_id\ntitle: $doc_title\n---\n```\n\n### sidebar\nUpdate sidebar from `website/sidebars.json`:\n```\n{\n  \"docs\": {\n    \"Intro\": [ // category name\n      \"intro\" // doc_id\n    ],\n    ...\n    \"About\": [\n      \"usecase\",\n      \"qna\"\n    ]\n  }\n}\n```\n\n## Publish\n### before publish\n- install [`yarn`](https://yarnpkg.com/lang/en/docs/install/)\n- install node module dependencies `cd website \u0026\u0026 yarn install`\n\n### ship\n- `chmod +x ./ship.sh`\n- `./ship.sh -v $version -u $github_username`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcovenantsql%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcovenantsql%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcovenantsql%2Fdocs/lists"}