This folder is the Salesforce knowledge base for the Codex-ready Salesforce coding engine.
Codex must read the relevant parts of this folder before editing Apex, LWC, Aura, Visualforce, metadata, tests, deployment files, Salesforce Files, or mobile behavior.
Start with INDEX.md.
| Folder | Purpose |
|---|---|
| GUIDES/ | Broad Salesforce platform guidance. |
| TOPICS/ | Focused notes by task area. |
| PATTERNS/ | Good patterns and anti-patterns. |
| PROMPTS/ | Reusable Codex prompts. |
| CHECKLISTS/ | Preflight and review checklists. |
| EXAMPLES/ | Public-safe Apex, LWC, and metadata examples. |
| REFERENCE/ | Glossary, CLI reference, lesson catalog, and project discovery templates. |
| DOCS/ | Documentation governance, engineering principles, and public-safety policy. |
- Read INDEX.md.
- Choose the task-specific guides and topic folders.
- Inspect the real Salesforce DX project under
force-app/main/default. - Verify object, field, metadata, permission, profile, record type, component, and Apex names in real project metadata.
- Apply the smallest safe fix.
- Update Memory and History after meaningful work.
| Document | Use |
|---|---|
| DOCS/documentation-governance.md | Documentation precedence, conflict handling, and placement rules. |
| DOCS/public-sanitization-policy.md | Public-safe documentation and release safety. |
| REFERENCE/project-discovery-template.md | Template for mapping an unfamiliar real Salesforce DX project. |
| CHECKLISTS/project-discovery.md | Checklist for broad project discovery. |
The files here are guidance and public-safe examples. They are not automatically the user's live Salesforce source. Codex must locate the real force-app/main/default folder before editing deployable metadata.