mostly documentation updates

[kristinaquinones]

This pull request standardizes and improves the documentation structure and maintenance practices across the project. It introduces a new, well-defined organization for developer and example documentation, updates all references and templates to match the new structure, and adds comprehensive instructions for maintaining documentation quality and consistency. Additionally, the .env.example file has been clarified and reorganized for better usability.

Documentation Structure and Maintenance

• Introduced a new documentation organization with clear directory structure and naming conventions: dev-docs/ for developer docs (with subfolders for specs, guides, planning, and progress logs) and docs/examples/ for example docs. Provided detailed instructions and checklists for maintaining documentation quality, updating cross-references, and ensuring all documentation changes are tracked in DOCUMENTATION.md. [1] [2]
• Added explicit requirements for updating documentation when features, architecture, setup, or organization change, and expanded the documentation review checklist to ensure accuracy and consistency. [1] [2]

Reference and Path Updates

• Updated all references to documentation files in .cursorrules, AGENTS.md, and .github/PULL_REQUEST_TEMPLATE.md to use the new dev-docs/ structure and relative paths, ensuring consistency throughout the codebase. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

Documentation Requirements in PRs

• Updated PR checklist requirements to reflect the new documentation structure, including progress logs in dev-docs/progress/, phase plans in dev-docs/planning/, and user/developer docs in dev-docs/. [1] [2] [3] [4] [5] [6]

.env.example Improvements

• Reorganized and clarified .env.example to group configuration options logically, provide better defaults, and improve documentation for each variable. Added branding, navigation, footer, content, and theme options with clear comments and examples.

Sync and Maintenance Instructions

• Updated sync instructions and checklists in .cursorrules and AGENTS.md to ensure all three core standards files remain consistent, and that documentation structure changes are reflected in all relevant places, including DOCUMENTATION.md. [1] [2] [3]

These changes will make it easier for all contributors to find, update, and maintain documentation, and will help ensure that documentation quality remains high as the project evolves.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
emberdocs	Ready	Preview, Comment	Jan 2, 2026 6:21am