From 36286aa0c8475edb0c887758c629a23d32a3d4b1 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sun, 31 Aug 2025 02:05:47 +0000 Subject: [PATCH] Create initial README.md with documentation structure and quick links Co-authored-by: joshua --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..0d5a606ca --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# TypeDB Documentation + +🚀 **[Get started quickly with TypeDB Cloud →](https://cloud.typedb.com)** + +Welcome to the TypeDB Documentation repository. This contains comprehensive documentation for TypeDB, covering everything from basic concepts to advanced usage patterns. + +## Documentation Structure + +- **[Get Started](docs/00-get-started/)** - Setup guides and quickstart tutorials +- **[Cloud Deployment](docs/01-cloud-deployment/)** - TypeDB Cloud deployment and management +- **[Knowledge Model](docs/02-knowledge-model/)** - Core concepts and data modeling +- **[Building Schema](docs/03-building-schema/)** - Schema design and implementation +- **[Querying Data](docs/04-querying-data/)** - TypeQL queries and data retrieval +- **[Distributed Analytics](docs/05-distributed-analytics/)** - Analytics and distributed computing +- **[Visualization Dashboard](docs/07-visualisation-dashboard/)** - Data visualization tools +- **[Java Library](docs/08-java-library/)** - Java driver documentation +- **[Language Drivers](docs/09-language-drivers/)** - Client drivers for various languages +- **[API References](docs/10-api-references/)** - Complete API documentation +- **[Resources](docs/11-resources/)** - Additional resources and examples +- **[Examples](docs/12-examples/)** - Code examples and use cases + +## Quick Links + +- 🌐 **[TypeDB Cloud](https://cloud.typedb.com)** - Get started with TypeDB in the cloud +- 📖 **[Main Documentation Portal](docs/0-index.md)** - Browse the full documentation +- 💬 **[Community Forum](http://discuss.grakn.ai)** - Get help and discuss with the community +- 📱 **[Slack Channel](https://grakn.ai/slack)** - Real-time community chat + +## Contributing + +We welcome contributions to improve the documentation. Please see our [contributing guidelines](contributors/index.html) for more information. \ No newline at end of file