Files
sure/docs/llm-guides/README.md
T
Juan José Mata 157daf5176 Consolidate repository instructions after auditing their history (#3409)
* Document instruction inventory and preservation decisions

Trace main history from September 2025 through September 2026, including earlier policy origins. Record preserved requirements, detailed-guide destinations, stale facts, harness boundaries and explicit policy-strength decisions before consolidating instruction sources.

* Consolidate repository instructions into shared guidance

Keep AGENTS concise and vendor neutral, move detailed conventions into shared guides, and use thin adapters with preserved Cursor scopes. Preserve the strict pre-PR checks globally and document the stronger scope, retired migration pin and rule-generation trigger. Update existing API guidance verification without changing application behavior.

* Narrow the always-on Cursor UI adapter and correct the SimpleFIN comment

Split the design-system guidance out of docs/llm-guides/ui.md into
docs/llm-guides/design-system.md. The ui-ux-design-guidelines rule is
alwaysApply: true, so importing all of ui.md loaded the Stimulus,
localization and ViewComponent guidance (previously confined to scoped
rules) on every Cursor session; the always-on adapter now imports only the
design-system guide, matching the scope it had before the consolidation.
view_conventions and stimulus_conventions keep the full UI guide.

Also correct the stale Provider::Simplefin header comment: pending
inclusion defaults on and is resolved by the importer (explicit argument,
then SIMPLEFIN_INCLUDE_PENDING, then Setting.syncs_include_pending); the
previous comment described the flag as default-off.

* Read guidance files as UTF-8 in the API consistency validators

The frontmatter regex match ran against content read with the locale
default external encoding; the Cursor rule's description contains an em
dash, so under US-ASCII (LC_ALL=C) Regexp#match raised ArgumentError,
breaking the standalone no-Rails fallback the docs point contributors to.
Read all checked files with an explicit UTF-8 encoding in both the
standalone script and the Rails test.
2026-09-06 07:14:43 +02:00

1.8 KiB

Development guides

Start with repository guidance, then read the guide for the work being changed. These guides hold the detailed conventions and procedures.

Task Guide
Understand the domain and write Rails code Architecture and conventions
Set up an environment, run checks or prepare a PR Development and verification
Write behavioral tests and fixtures Testing
Change design tokens or DS::* primitives Design system
Change views, components, CSS, Stimulus or localization UI
Add or modify an API v1 endpoint API endpoint consistency
Change provider imports, pending/FX metadata or diagnostics Provider sync guidance
Add a securities price provider Provider walkthrough
Gate or release a preview feature Preview-feature gating
Change goals, pledges or reconciliation Goals

External wealth integration

Wealth history with an external agent harness describes Sure's read-only tool interface and the boundary with an external wealth system. The wealth blueprint is reference architecture for that separate system. Its working-memory files, private document vault and operating protocol apply to that external project, not to every change in this repository.

Instruction maintenance

Harness adapters documents discovery, supported imports, scoped loading and legacy helpers. The preservation map records the inventory, history, dispositions and intentional policy decisions for the consolidation; it is an audit record rather than additional coding policy.