Skip to content

Comments

Add Hello World section to README#8

Open
flyingsilverfin wants to merge 2187 commits intomasterfrom
INT-1-hello-world-test
Open

Add Hello World section to README#8
flyingsilverfin wants to merge 2187 commits intomasterfrom
INT-1-hello-world-test

Conversation

@flyingsilverfin
Copy link
Owner

@flyingsilverfin flyingsilverfin commented Jan 25, 2026

Change & Motivation

This PR adds a 'Hello World' section at the bottom of the TypeDB documentation README to provide newcomers with a quick, practical example of TypeQL syntax. The section demonstrates:

  • Defining a simple schema with entities and attributes
  • Inserting data
  • Querying data

This addition complements the documentation contribution guidelines and helps contributors and readers understand basic TypeDB/TypeQL patterns at a glance.

Implementation

  • Added a new 'Hello World' section at the end of README.md
  • Included a concise TypeQL example showing schema definition, data insertion, and querying
  • Added a link to the comprehensive documentation portal

Related to Linear issue INT-1


Note

Build/Tooling

  • Introduces Bazel setup: .bazelrc, .bazelversion, WORKSPACE, BUILD, and VERSION
  • Adds CI/release automation via .factory/automation.yml (content tests, code snippet runners, and deploy jobs)

Repo hygiene

  • Adds .gitignore, CODEOWNERS, issue/PR templates under .github/

Docs structure

  • Removes legacy academy Markdown pages and adds Antora module (academy/antora.yml)
  • Adds academy/modules/ROOT/attachments/ assets, including book-csv-builder.py and books.csv

README

  • Expands documentation and adds a TypeQL "Hello World" example

Written by Cursor Bugbot for commit 7e30137. This will update automatically on new commits. Configure here.

flyingsilverfin and others added 29 commits November 14, 2025 21:53
## Goal

Add a guide on moving between SQL and TypeQL under Core Concepts / TypeQL . 

## Implementation
- add new page to typeql core concepts
- simplify testing framework for typeql snippets
- stop testing one minor test that was panicking the server (should be restored ideally)
## Goal

We fix glossary and corresponding pages with missing and incorrectly
documented operators.
## Goal
Adds an example with the `insert $owner has attr-type == $value;`
## Goal
Replaces any broken references to reflect the move from `/reference/typeql` to `/typeql-reference`

## Implementation
Also nukes a copy of the tql files, fixes up includes and the tests which were failing for distinct & require by updating the queries.
## Goal
Introduce an antora playbook for testing . Any pages from external modules which are referenced are mocked.

## Implementation
* Move the code testing from `test` to `test/code`
* Introduces the antora playbook file
* Creates the `mock` folder. 
* Fixes any errors found along the way.
## Goal
Adds analyze documentation to diver core-concepts

## Implementation
Also updates driver dependencies to 3.7.0
## Goal

We add documentation for `try {}` in write stages (`insert`, `put`,
`update`, `delete`).

## Implementation
## Goal

We've done a pass over our date & time literal examples to keep them as
intuitive as possible

## Implementation

Split date & datetime examples into two blocks - one block for literals
without the leading + symbol to denote a non-four-digit year - this is
the default that everyone should expect & be used to - and we separate
out the examples with a leading + into a separate clearly indicated
block

For example:

```
Example date literals
2024-03-30
1920-09-21
#!test[read]
#{{
match
  let $x = 2024-03-30;
  let $y = 1920-09-21;
#}}

Example date literals (non-4-digit year)
+20000-01-01
+900-09-21
#!test[read]
#{{
match
  let $x = +20000-01-01;
  let $y = +900-09-21;
#}}
```
Update docker instructions to mount volume at `typedb-server-(...)` instead of `typedb-all-(...)`
## Goal

We add three new language guides in Guides : TypeQL and move what was
previously Tutorials under Guides : Integrations. We also move the
TypeQL vs SQL comparison page under Guides : TypeQL.

## Implementation
## Goal

We add the clarification that if the input is halfway between two
integers, `round()` rounds to the nearest even integer.

## Implementation
## Goal
Add the python graph visualisation tutorial based on the jupyter notebook in typedb/typedb-graph-utils
This commit adds a concise 'Hello World' TypeQL example at the end of the README,
demonstrating basic TypeDB operations including:
- Defining a simple schema
- Inserting data
- Querying data

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.

This PR is being reviewed by Cursor Bugbot

Details

You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.


ADDRESS = "localhost:1729"
DATABASE = "bookstore"
OUTPUT = "learn-src/modules/ROOT/attachments/books.csv"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Script output path doesn't match file location

Low Severity

The OUTPUT variable is set to "learn-src/modules/ROOT/attachments/books.csv" but the file is located at academy/modules/ROOT/attachments/books.csv. Running this script would write to the wrong directory (or fail if learn-src/ doesn't exist). The path prefix appears to be from a different repository structure.

Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants