Skip to content
Snippets Groups Projects
mkdocs.yml 12.17 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
markdown_extensions:
  - attr_list
  - admonition
  - def_list
  - codehilite(guess_lang=false)
  - toc(permalink=true)
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tilde
  - pymdownx.betterem
  - pymdownx.mark
pages:
- Home: index.md
- Basics:
  - Developer Community: basics/community.md    # page-tree = DONE
  - Useful Skills: basics/skills.md       # page-tree = DONE
  - Planning Your Project: basics/planning.md   # page-tree = DONE
  # buildkit: /setup/buildkit.md                # page-tree = NEED_NEW_PAGE  # summary: See Github README for download instructions. Alternatively, follow links and install particular tools as-needed.
  - Debugging: dev-tools/debugging.md           # page-tree = NEED_PAGE_MOVE to /setup/debugging.md
- Core Development:
  - When to Edit Core: core/hacking.md             # page-tree = NEED_PAGE_MOVE to /core/deciding.md
  - How to Contribute: core/contributing.md    # page-tree = DONE
  - Codebase & Architecture: core/architecture.md # page-tree = DONE
  # Reporting Bugs & Issues: /core/reporting.md # page-tree = NEED_NEW_PAGE
  # Submitting a Patch: /core/patches.md        # page-tree = NEED_NEW_PAGE
  # Review Process: /core/review.md             # page-tree = NEED_NEW_PAGE  # summary: Detailed guidance on how to review PRs
  # Verifying a Bug Fix: /core/verifying.md     # page-tree = NEED_NEW_PAGE
- Extensions Development:
  - Basics: extensions/basics.md                   # page-tree = DONE
  - civix: extensions/civix.md                     # page-tree = DONE
  # Creating Pages: extensions/create-page.md      # page-tree = NEED_NEW_PAGE
  # Storing Configuration: extensions/config.md    # page-tree = NEED_NEW_PAGE
  # Storing Data: extensions/storing-data.md       # page-tree = NEED_NEW_PAGE
  # Setting Permissions: extensions/permissions.md # page-tree = NEED_NEW_PAGE
  # Adding API Functions: extensions/api.md        # page-tree = NEED_NEW_PAGE
  # Reports: extensions/reports.md                 # page-tree = NEED_NEW_PAGE
  # Searches: extensions/searches.md               # page-tree = NEED_NEW_PAGE
  # Payment Processors: extensions/payment-processors.md # page-tree = NEED_NEW_PAGE
  - Publishing Extensions: extensions/publish.md   # page-tree = DONE
  - Extension Lifecycle: extend-stages.md          # page-tree = NEED_PAGE_MOVE to /extensions/lifecycle.md
  - Troubleshooting: extensions/troubleshooting.md # page-tree = DONE
  - Advanced patterns: extensions/advanced.md
  #### Framework Reference:
  # Bootstrap: /framework/bootstrap.md          # page-tree = NEED_NEW_PAGE
  # Cache: /framework/cache.md                  # page-tree = NEED_NEW_PAGE
  # Components: /framework/components.md        # page-tree = NEED_NEW_PAGE
  # Database: /framework/database.md            # page-tree = NEED_NEW_PAGE
  # Resources: /framework/resources.md          # page-tree = NEED_NEW_PAGE
  # Upgrade: /framework/upgrade.md              # page-tree = NEED_NEW_PAGE
  #### Code Standards:
  # PHP: /standards/php.md                      # page-tree = NEED_NEW_PAGE
  # Javascript: /standards/js.md                # page-tree = NEED_NEW_PAGE
  # API: /standards/api.md                      # page-tree = NEED_NEW_PAGE
  # Git: /standards/git.md                      # page-tree = NEED_NEW_PAGE
  #### Testing:
  # Testing: /testing/testing.md                # page-tree = NEED_NEW_PAGE
  # Other Reference:
  # CiviMail: /reference/civimail.md            # page-tree = NEED_NEW_PAGE
  # CiviReport: /reference/civireport.md        # page-tree = NEED_NEW_PAGE
  # Payment Processing: /reference/payment.md   # page-tree = NEED_NEW_PAGE
- API:
  - API Intro: api/general.md                   # page-tree = DONE
  - API Usage: api/usage.md                     # page-tree = DONE
  - API Actions: api/actions.md                 # page-tree = DONE
  - API Parameters: api/params.md               # page-tree = DONE