Skip to content

AGENTS

Mission

This repository hosts the SJF4J documentation site. Keep docs aligned with the main ../sjf4j project, but prefer small, targeted edits.

Rules

  • Treat ../sjf4j as the feature/API reference when updating docs.
  • Prefer localized documentation fixes over broad rewrites.
  • Keep terminology and examples consistent with current SJF4J APIs.
  • Do not manually edit synced files:
    • docs/changelog.md
    • docs/getting_started.md
  • If a requested doc change would affect a synced file, stop and tell the user instead of editing it.

Priority Areas

  • docs/binding.md
  • docs/navigating.md
  • docs/patching.md
  • docs/validating.md
  • docs/modeling.md
  • docs/mapping.md