{"id":18895014,"url":"https://github.com/dolthub/docs","last_synced_at":"2025-04-15T00:32:24.062Z","repository":{"id":37059576,"uuid":"326725339","full_name":"dolthub/docs","owner":"dolthub","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-14T19:03:04.000Z","size":104245,"stargazers_count":8,"open_issues_count":18,"forks_count":21,"subscribers_count":8,"default_branch":"gitbook-dev","last_synced_at":"2025-04-14T20:22:28.682Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/dolthub.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}},"created_at":"2021-01-04T15:25:00.000Z","updated_at":"2025-04-14T19:03:04.000Z","dependencies_parsed_at":"2023-09-26T04:19:20.792Z","dependency_job_id":"998212c9-0e67-4b22-9a6f-29d15b490e01","html_url":"https://github.com/dolthub/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolthub%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolthub%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolthub%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolthub%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dolthub","download_url":"https://codeload.github.com/dolthub/docs/tar.gz/refs/heads/gitbook-dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248984558,"owners_count":21193771,"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-08T08:26:05.260Z","updated_at":"2025-04-15T00:32:19.049Z","avatar_url":"https://github.com/dolthub.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: Dolt Documentation\n---\n\n## Introduction\n\nThis repository contains Dolt, DoltHub, DoltLab, and Doltgres documentation. Check out our [website](https://www.dolthub.com), [team](https://www.dolthub.com/team), and documentation to learn more:\n\n- [Dolt](https://docs.dolthub.com)\n- [Doltgres](https://docs.doltgres.com)\n- [DoltLab](https://docs.doltlab.com)\n\n## GitBook Hosting\n\nWe use [GitBook](https://www.gitbook.com/) to publish our documentation, and delegate the subdomain `docs.[product].com` to `dolt.gitbook.io`. GitBook operates by syncing the contents of this repository. The GitBook/GitHub integration is documented [here](https://docs.gitbook.com).\n\nUsing GitBook requires us to adopt their model of content structuring in order to properly render our markdown. The restrictions are as follows:\n\n- the root directory is set in `.gitbook.yaml`\n- assets, i.e. images, need to live in `content/.gitbook/assets`\n- the content structure is configured in `content/SUMMARY.md`\n\n## Contribution Workflow\n\nWe have two GitBook \"spaces\" for each product, one for development and review, and one for production:\n\n- \"Dolt\", which [docs.dolthub.com](https://docs.dolthub.com/) links to, and syncs off of `gitbook-publish`\n- \"Dolt Dev\", which is [dolt.gitbook.io/dolt-dev](https://dolt.gitbook.io/dolt-dev/), and syncs off of `gitbook-dev`\n\nTo make a contribution create a feature branch, either in a fork or in this repository, and then make a PR against `gitbook-dev`. This can be reviewed and merged, which will result in it being deployed to \"Dolt Dev\" space. Once it has been reviewed in GitBook we can merge `gitbook-dev` to `gitbook-publish`, and it will land in production.\n\nTo add a new page to the docs, make sure you update [SUMMARY.md](https://github.com/dolthub/docs/blob/gitbook-publish/content/SUMMARY.md)\n\nTo update Dolt CLI reference docs, make updates to the Dolt command code in the `dolt` repo, then run `dolt dump-docs` to regenerate the CLI markdown file and copy it to `content/reference/cli/cli.md`.\n\nTo recap:\n\n- make changes on `your-feature-branch`\n- if adding a new page, update [SUMMARY.md](https://github.com/dolthub/docs/blob/gitbook-publish/content/SUMMARY.md)\n- review and merge to `gitbook-dev`, `gitbook-dev` syncs to [Dolt Dev](https://dolt.gitbook.io/dolt-dev/)\n- once you are satisfied with your changes, merge `gitbook-dev` to `gitbook-publish`, at which point your changes will sync'd to production\n\nThe following diagram illustrates the workflow:\n![GitHub/GitBook Workflow](gitbook_workflow.png)\n\n### All spaces\n\n- [Dolt](https://docs.dolthub.com)\n- [Dolt Dev](https://dolt.gitbook.io/dolt-dev/)\n- [Doltgres](https://docs.doltgres.com)\n- [Doltgres Dev](https://dolt.gitbook.io/doltgres-dev/)\n- [DoltLab](https://docs.doltlab.com)\n- [DoltLab Dev](https://dolt.gitbook.io/doltlab-dev/)\n\n## Check Dead Links\n\nThis [tool](https://www.deadlinkchecker.com/) is free and works quite well if you just pass the dev URL, `https://dolt.gitbook.io/dolt-dev/`, into it.\n\n## Styling Tips\n\nYou can create a styled info box for a note callout by including the following:\n\n```\n{% hint style=\"info\" %}\n### Note\nMy styled note!\n{% endhint %}\n```\n\n## Embed DoltHub SQL Console\n\nYou can embed DoltHub SQL console by including the following:\n\n```\n{% embed url=\"https://www.dolthub.com/repositories/[owner]/[database]/embed/[refName]?q={query}\" %}\n```\n\nSome system tables are not supported on DoltHub, for example, `dolt_conflicts`, running `select * from dolt_conflicts` will return the query error: `dhdolt: ReadOnlyChunkStore: Unimplemented.`\nMake sure the query works on DoltHub before adding the console.\n\nTo avoid timeout, use a small-size database. sometimes queries with `ORDER BY` will time out. After removing `ORDER BY`, it will return much faster.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdolthub%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdolthub%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdolthub%2Fdocs/lists"}