Skip to content
Snippets Groups Projects
mkdocs.yml 10.45 KiB
site_name: Developer Guide
repo_url: https://github.com/civicrm/civicrm-dev-docs
site_description: A guide for CiviCRM developers.
site_author: The CiviCRM community
theme: material

pages:
- Home: index.md
- Basics:
  - Developer Community: basics/community.md
  - Useful Skills: basics/skills.md
  - Planning Your Project: basics/planning.md
  - File System: basics/filesystem.md
- Development tools:
  - Development tools: tools/index.md
  - Buildkit: tools/buildkit.md
  - civibuild: tools/civibuild.md
  - cividist: tools/cividist.md
  - GitHub: tools/github.md
  - PhpStorm: tools/phpstorm.md
  - Debugging: tools/debugging.md
- Core Development:
  - When to Edit Core: core/hacking.md
  - How to Contribute: core/contributing.md
  - Reviewing PR's: core/pr-review.md
  - Codebase & Architecture: core/architecture.md
  # Reporting Bugs & Issues: /core/reporting.md
  # Submitting a Patch: /core/patches.md
  # Verifying a Bug Fix: /core/verifying.md
- Extensions Development:
  - Basics: extensions/index.md
  - civix: extensions/civix.md
  # Creating Pages: extensions/create-page.md
  # Storing Configuration: extensions/config.md
  # Storing Data: extensions/storing-data.md
  # Setting Permissions: extensions/permissions.md
  # Adding API Functions: extensions/api.md
  # Reports: extensions/reports.md
  # Searches: extensions/searches.md
  # Payment Processors: extensions/payment-processors.md
  - Publishing Extensions: extensions/publish.md
  - Extension Lifecycle: extensions/lifecycle.md
  - Troubleshooting: extensions/troubleshooting.md
  - Advanced patterns: extensions/advanced.md
- Framework Reference:
  # Bootstrap: /framework/bootstrap.md
  # Cache: /framework/cache.md
  # Components: /framework/components.md
  # Database: /framework/database.md
  - Schema definition: framework/schema-definition.md
  # Resources: /framework/resources.md
  # Upgrade: /framework/upgrade.md
  #### Code Standards:
  # PHP: /standards/php.md
  # Javascript: /standards/js.md
  # API: /standards/api.md
  # Git: /standards/git.md
  #### Testing:
  # Testing: /testing/testing.md
  # Other Reference:
  # CiviMail: /reference/civimail.md
  # CiviReport: /reference/civireport.md
  # Payment Processing: /reference/payment.md
- API:
  - APIv3 Intro: api/index.md
  - APIv3 Usage: api/usage.md
  - APIv3 Actions: api/actions.md
  - APIv3 Parameters: api/params.md
  # APIv3 Permissions: api/permissions.md
  - APIv3 Joins: api/joins.md