wdevs/relspecgo
5
0
Fork 0
Code Issues 9 Pull Requests 6 Actions Packages Releases 83 Wiki Activity

docs: add usage examples for each format combination #42

Merged
warkanum merged 2 commits from issue-37-usage-examples into master 2026-10-03 07:27:03 +00:00
Conversation 0 Commits 2 Files Changed 2
+105
sgcommand commented 2026-10-03 03:09:18 +00:00
Member
Copy Link
Copy Source

Summary

  • Add docs/FORMAT_EXAMPLES.md with DBML-to-writer and reader usage examples.
  • Cover cross-format, live-database, and non-convert format guidance.
  • Link the format examples from the README supported-formats section.
  • Clarify which examples were executed and document the known GORM-to-DBML issue.

Verification

  • git diff --check — passed.
  • go test ./... — passed.
  • Built the CLI and exercised the documented DBML-to-writer examples for JSON, YAML, DCTX, DrawDB, GraphQL, Prisma, PostgreSQL, MSSQL, SQLite, Drizzle, TypeORM, GORM, and Bun — passed.

Issue: #37

## Summary - Add `docs/FORMAT_EXAMPLES.md` with DBML-to-writer and reader usage examples. - Cover cross-format, live-database, and non-`convert` format guidance. - Link the format examples from the README supported-formats section. - Clarify which examples were executed and document the known GORM-to-DBML issue. ## Verification - `git diff --check` — passed. - `go test ./...` — passed. - Built the CLI and exercised the documented DBML-to-writer examples for JSON, YAML, DCTX, DrawDB, GraphQL, Prisma, PostgreSQL, MSSQL, SQLite, Drizzle, TypeORM, GORM, and Bun — passed. Issue: #37
sgcommand added 2 commits 2026-10-03 03:09:18 +00:00
docs: add usage examples for each format combination (#37) 54041228c9 
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
docs: clarify format example coverage 519ee4f6eb
warkanum merged commit 734b14d48d into master 2026-10-03 07:27:03 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Medium
3
The priority is medium
Priority
Low
4
The priority is low
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
Status
Abandoned
3
Somebody has started to work on this but abandoned work
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
hein (Hein) root sam sgcommand (SG Command) support warkanum (Warky)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: wdevs/relspecgo#42