Skip to content

Feature: Add on new documentation for zkdb-doc#25

Open
SangTran-127 wants to merge 2 commits intomainfrom
feature/refactor_document
Open

Feature: Add on new documentation for zkdb-doc#25
SangTran-127 wants to merge 2 commits intomainfrom
feature/refactor_document

Conversation

@SangTran-127
Copy link
Copy Markdown
Contributor

No description provided.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR modernizes the zkDatabase documentation to reflect a major API migration from an authentication-based model to an API key-based architecture, introduces a Result pattern for error handling, and updates the schema definition syntax. The PR also removes outdated authentication documentation and blog content.

Key Changes:

  • Migrates from ZkDatabase.connect() with user credentials to new ZkDatabase() with API keys
  • Introduces Result pattern (.unwrap(), .isOk(), .isErr()) for error handling across all async operations
  • Updates schema syntax from Schema.create() class-based approach to new Schema() array-based field definitions
  • Removes authentication-related documentation (sign-up, sign-in, sign-out)

Reviewed changes

Copilot reviewed 34 out of 35 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/dynamic.tsx Updates all code examples to use new API key authentication, Result pattern, and new Schema syntax
src/components/HomepageFeatures/index.tsx Code formatting changes (single to double quotes, spacing improvements)
docusaurus.config.ts Adds type safety for BUILD_MODE environment variable with proper type casting
docs/getting-started.mdx New file replacing getting-stated.mdx with updated installation and API key setup instructions
docs/intro.md Updates to reflect Groth16 zkSNARKs usage and removes o1js-specific references
docs/concept/schema.md Updates schema documentation to new array-based field definition syntax
docs/zk-proof/*.mdx Updates all zk-proof methods to use Result pattern and new method signatures
docs/verifcation-key/verifcation-key-get.mdx Updates verification key retrieval to use Result pattern
docs/document/*.mdx Updates all document operations (insert, update, find, drop, merkle-tree) to use Result pattern
docs/database/*.mdx Updates database operations (create, info) to use Result pattern and remove merkle height parameter
docs/collection/*.mdx Updates collection operations (create, list) to use new Schema syntax and Result pattern
docs/group/*.mdx Updates group operations (create, manage) to use Result pattern
docs/authentication/* Removes all authentication documentation files (sign-up, sign-in, sign-out)
blog/* Removes all blog content and configuration files

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants