Skip to content

notes.md

Latest commit

 

History

History
77 lines (57 loc) · 3.18 KB

notes.md

File metadata and controls

77 lines (57 loc) · 3.18 KB
Raw

Maintainer Notes

This page keeps repo-maintenance notes that are useful to review with the codebase. Framework behavior is documented in the focused docs linked from the Documentation Index.

Documentation Practice

  • Keep framework documentation in docs/, not in a GitHub Wiki.
  • Keep docs versioned with code and reviewed in pull requests.
  • Prefer concise reference docs over planning transcripts.
  • A future docs website can publish these files when the docs are stable enough for a public site.

CLI And Directory Shape

CLI and Directory Shape are the source references for the command surface and filesystem layout.

The current conventions are:

  • Centralize path constants and slash-target parsing.
  • Use root dygo.yml, config/, .dygo/, and db/schema.sql.
  • Use canonical Entity bundles at apps/<app>/entities/<entity>/<entity>.entity.yml.
  • Store Entity fixtures at apps/<app>/entities/<entity>/fixtures.yml.
  • Use dygo db migrate, dygo db prune, singular command groups, and --yes / --dry-run write safety.
  • Keep dygo upgrade project-only; update binaries out of band through installers.
  • Put scaffolding under dygo generate and alias dygo g.
  • Keep hook generation under dygo generate hook; use dygo hook for inspection and wiring maintenance.
  • Keep route validation filesystem-backed.
  • Include route, fixture, hook, Job, Schedule, schema snapshot, config, secrets, database, Studio assets, and first-run setup checks in dygo doctor.

Coming Soon

These are intentionally not part of the current public CLI contract:

  • global --json
  • smart shell completions
  • report runtime
  • custom page runtime
  • Studio schedule UI
  • Studio retry and cancel controls for Job Executions
  • production secret providers such as KMS or Vault

Reduction Scan

These notes came from a static reduction scan. Re-check each item before deleting or refactoring code.

High-confidence delete candidates:

  • apps/studio/ui/src/design/atoms/Divider.vue
  • apps/studio/ui/src/design/molecules/FieldRow.vue
  • apps/studio/ui/src/design/molecules/FormSection.vue
  • apps/studio/ui/src/design/molecules/SearchBox.vue
  • apps/studio/ui/src/design/molecules/RadioGroupField.vue
  • apps/studio/ui/src/design/primitives/RadioGroup.vue

DRY candidates:

  • Share fixture dependency sorting between validation and apply.
  • Share nested fixture link decoding between validation and apply.
  • Reduce repeated public identity and layout dispatch in Record CRUD.
  • Table-drive generator command construction.
  • Share field normalization and editor selection across record renderers.

Large files to watch:

  • internal/db/records.go
  • internal/db/schema_plan.go
  • internal/fixtures/fixtures.go
  • internal/cli/db.go
  • apps/studio/ui/src/design/organisms/DataTable.vue
  • apps/studio/ui/src/pages/RecordFormPage.vue
  • apps/studio/ui/src/renderers/records/RecordCollectionTable.vue
  • internal/cli/root_test.go
  • internal/db/records_test.go

Naming notes:

  • internal/studio/assets.go is really Studio bundle source resolution, cache installation, and static handler wiring.
  • internal/fixtures/fixtures.go may read better split into discovery, validation, and apply files.