Skip to content
Snippets Groups Projects
mkdocs.yml 12.64 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
  - Requirements: basics/requirements.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
  - civilint: tools/civilint.md
  - Issue Tracking: tools/issue-tracking.md
  - Git, GitHub, & GitLab: tools/git.md
  - Jenkins: tools/jenkins.md
  - PhpStorm: tools/phpstorm.md
  - Debugging: tools/debugging.md
- Core Development:
  - When to Edit Core: core/hacking.md
  - Release process: core/release-process.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
  - Packaging options: extensions/packaging.md
  - civix: extensions/civix.md
  - Extension Structure: extensions/structure.md
  - info.xml file: extensions/info-xml.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
  - Customizing screens: extensions/custom-screens.md
- Testing:
  - Testing Setup: testing/setup.md
  - "PHPUnit Tests": testing/phpunit.md
  - "Javascript Tests": testing/javascript.md
  - "Selinium Tests": testing/selinium.md
  - "Continuous Integration": testing/continuous-integration.md
  - "Upgrade Tests": testing/upgrades.md
  - Manual Testing: testing/manual.md
- Framework Reference:
  - AngularJS:
    - "AngularJS: Intro": framework/angular/index.md
    - "AngularJS: Quick Start": framework/angular/quickstart.md
    - "AngularJS: File Names": framework/angular/files.md
    - "AngularJS: Loader": framework/angular/loader.md
    - "AngularJS: Changesets":  framework/angular/changeset.md
  - "API architecture": framework/api-architecture.md
  - Asset Builder: framework/asset-builder.md