Skip to content

Comments

fix(docs): correct documentation errors and sync with source code#15

Merged
arcaela merged 1 commit intomainfrom
feature/14
Jan 9, 2026
Merged

fix(docs): correct documentation errors and sync with source code#15
arcaela merged 1 commit intomainfrom
feature/14

Conversation

@arcaela
Copy link
Member

@arcaela arcaela commented Jan 9, 2026

Summary

  • Fix typo in source code type definition
  • Correct timestamp types and naming conventions
  • Add missing decorators and operators to documentation
  • Sync documentation with actual API

Changes

Source Code

  • table.ts:43: Fixed typo BelognsToBelongsTo

Documentation (EN)

  • Fixed timestamp type Datestring
  • Added missing await calls
  • Documented tx?: TransactionContext parameter
  • Added $exists/$notExists operators
  • Added @HasOne and @ManyToMany decorators
  • Fixed snake_case timestamps

Translations (ES/DE)

  • Fixed timestamp types

Test plan

  • Verify TypeScript compilation passes
  • Verify documentation renders correctly
  • Confirm all code examples are syntactically valid

Closes #14

- Fix typo BelognsTo → BelongsTo in table.ts type definition
- Fix timestamp type Date → string in index.md, index.es.md, index.de.md
- Add missing await to ConfigureDatabase() in installation.md
- Document tx parameter in create(), update(), delete() methods
- Add $exists/$notExists operators to table.md
- Add @hasone decorator to index.md and core-concepts.md
- Fix camelCase timestamps to snake_case in core-concepts.md
- Remove non-existent operators from documentation

Closes #14
@arcaela arcaela merged commit 57432ac into main Jan 9, 2026
1 of 3 checks passed
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.

fix(docs): correct documentation errors and sync with source code

1 participant