{"id":13558492,"url":"https://github.com/dgraph-io/dgraph-docs","last_synced_at":"2026-01-30T03:45:38.137Z","repository":{"id":39898918,"uuid":"322322404","full_name":"dgraph-io/dgraph-docs","owner":"dgraph-io","description":"A native GraphQL Database with a graph backend","archived":false,"fork":false,"pushed_at":"2025-12-12T22:20:45.000Z","size":142092,"stargazers_count":35,"open_issues_count":9,"forks_count":67,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-12-14T12:54:27.629Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://dgraph.io/docs","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dgraph-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","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-17T14:38:50.000Z","updated_at":"2025-12-12T20:58:34.000Z","dependencies_parsed_at":"2023-09-22T09:41:03.354Z","dependency_job_id":"9c16a7b9-d98c-4699-878c-1fbea6186840","html_url":"https://github.com/dgraph-io/dgraph-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dgraph-io/dgraph-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgraph-io%2Fdgraph-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgraph-io%2Fdgraph-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgraph-io%2Fdgraph-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgraph-io%2Fdgraph-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dgraph-io","download_url":"https://codeload.github.com/dgraph-io/dgraph-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgraph-io%2Fdgraph-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28899763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T03:36:35.398Z","status":"ssl_error","status_checked_at":"2026-01-30T03:36:34.949Z","response_time":66,"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":"2024-08-01T12:04:59.024Z","updated_at":"2026-01-30T03:45:38.131Z","avatar_url":"https://github.com/dgraph-io.png","language":"MDX","funding_links":[],"categories":["Shell","others"],"sub_categories":[],"readme":"# Dgraph Documentation\n\nTo read the official Dgraph documentation that is published from this repository,\nplease see https://docs.dgraph.io/.\n\n## Technology Stack\n\nThis documentation site is built with [Docusaurus](https://docusaurus.io/), a modern static website generator optimized for documentation.\n\n## Documentation Structure\n\nThe documentation is organized into four main sections, each managed by its own Docusaurus content plugin:\n\n1. **Docs** (`/`) - Core Dgraph database documentation including DQL, administration, installation, and design concepts\n2. **GraphQL** (`/graphql`) - GraphQL API documentation, schema, queries, mutations, and custom resolvers\n3. **Ratel UI** (`/ratel`) - Documentation for the Ratel web-based UI tool\n4. **Tutorials** (`/learn`) - Step-by-step tutorials and learning paths for different user types\n\nEach section has its own sidebar navigation configured in:\n- `sidebars.ts` - Docs sidebar\n- `sidebars-graphql.ts` - GraphQL sidebar\n- `sidebars-ratel.ts` - Ratel sidebar\n- `sidebars-learn.ts` - Tutorials sidebar\n\n## Running Locally\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/) version 20.0 or higher\n- npm or yarn package manager\n\n### Setup and Run\n\n1. Navigate to the Docusaurus directory:\n   ```bash\n   cd docusaurus-docs\n   ```\n\n2. Install dependencies:\n   ```bash\n   npm install\n   ```\n\n3. Start the development server:\n   ```bash\n   npm start\n   ```\n\n4. Open [http://localhost:3000](http://localhost:3000) in your browser.\n\nThe site will automatically reload when you make changes to the documentation files.\n\n### Build for Production\n\nTo build a production-ready static site:\n\n```bash\nnpm run build\n```\n\nThe built site will be in the `build/` directory. You can serve it locally with:\n\n```bash\nnpm run serve\n```\n### Testing the current version\nWhen testing locally you can set \n```\n        includeCurrentVersion: true,\n```\nin the docs or graphql plugin in `docusaurus.config.ts`.\n\nThis will expose `next` in the version selector, so you can view the current (non versioned) documentation.\n\n## Versioning\n\nDocusaurus supports documentation versioning. Versioned documentation is stored in:\n- `docs_versioned_docs/` - Versioned docs content\n- `docs_versioned_sidebars/` - Versioned sidebar configurations\n- `docs_versions.json` - Version metadata\n\nThe version dropdown in the navbar automatically detects which documentation section you're viewing and shows the appropriate versions. Currently, versioning is configured for \n-  `docs` section\n- `graphql` section\n\nTo create a new version:\n1. Use the Docusaurus CLI: `npm run docusaurus docs:version \u003cversion\u003e`\n2. This creates a new version snapshot of the current docs\n\n\n\n## Deployment\n\nThe documentation site is automatically deployed to CloudFlare:\n\n- **Main branch** (`main`) → Deployed to production at `https://docs.dgraph.io`\n- **Preview branches** (`preview/*`) → Deployed as preview deployments for review\n\nThe deployment process is handled automatically via CloudFlare Pages integration with GitHub.\n\n## Contribution Guidelines\n\nAs a contributor to Dgraph documentation, we ask that you do the following:\n- **Label your PR for easy management**: Your PR title should be in the following format: **Topic (area): details**. The **topic** is either \"Docs\", \"Nav\" (aka, navigation), or \"Chore\" (for build fixes, cherry-picks, etc). The **area** is the feature (i.e. \"GraphQL\"), area of the docs (i.e., \"Deployment\"), or \"Other\" (for typo fixes and other bugfix PRs). So, example PR names include:\n *Docs(GraphQL): Document the @deprecated annotation* \n\n- **Technical writing style**: As much as possible, please follow technical writing style conventions (More on this below).\n\n- **(Dgraph core team only)**: Include the ID of any issues/tickets related to your PR in the description (i.e., \"Fixes DGRAPH-12345\" or \"Per DGRAPH-54321\").\n\n### Technical Writing Style\n\nPlease follow the [Dgraph Documentation Style Guide](documentation-style-guide.md) for writing conventions, formatting, and best practices.\n\n**Note:** Please don't let these style conventions stop you from creating a PR to share your contribution to Dgraph Docs! PR reviewers can help with style guide issues.\n\n### References\n\nIn Docusaurus, use standard Markdown links for internal references. For example, to reference a term in the glossary:\n\n\n```markdown\n[UID](/dgraph-glossary#uid)\n```\n\n## File Structure\n\n```\ndocusaurus-docs/\n├── docs/              # Main documentation content\n├── docs-graphql/      # GraphQL documentation\n├── docs-ratel/        # Ratel UI documentation\n├── docs-learn/        # Tutorials and learning content\n├── docs_versioned_docs/    # Versioned documentation snapshots\n├── sidebars.ts        # Main docs sidebar configuration\n├── sidebars-graphql.ts     # GraphQL sidebar configuration\n├── sidebars-ratel.ts       # Ratel sidebar configuration\n├── sidebars-learn.ts       # Tutorials sidebar configuration\n├── docusaurus.config.ts    # Main Docusaurus configuration\n└── src/               # Custom components and styles\n```\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdgraph-io%2Fdgraph-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdgraph-io%2Fdgraph-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdgraph-io%2Fdgraph-docs/lists"}