Skip to content
This repository was archived by the owner on Jul 6, 2026. It is now read-only.

Add comprehensive developer documentation for PolirisBundle - #3

Merged
gilles-g merged 3 commits into
mainfrom
copilot/update-poliris-bundle-documentation
Nov 20, 2025
Merged

Add comprehensive developer documentation for PolirisBundle#3
gilles-g merged 3 commits into
mainfrom
copilot/update-poliris-bundle-documentation

Conversation

Copilot AI commented Nov 16, 2025

Copy link
Copy Markdown
Contributor

Created extensive English developer documentation (docs/DOCUMENTATION.md, 1,189 lines) covering the complete workflow for generating Poliris V4.1.17 CSV exports for French real estate portals (SeLoger, LeBonCoin).

Documentation Structure

Getting Started

  • Bundle purpose and installation
  • Complete working example with 2 property listings (apartment in Paris, house in Lyon)
  • CSV output format explanation with column mappings

Use Cases (4 scenarios)

  • SeLoger export with type/subtype mapping service
  • Photo integration (30 photos + virtual tour support)
  • Scheduled automation (Symfony Command, Cron, Event Subscriber, Messenger)
  • Common errors: invalid format (encoding, required fields) and memory exhaustion (batch processing)

Reference

  • All 31 models with CSV column positions (333 total columns)
  • Detailed documentation of core models (Identifiant, Type, Surface, Prix, Detail)

Troubleshooting

  • FAQ, production checklist, architecture diagram

Example Usage

use Spiriit\PolirisBundle\Builders\AnnonceExportBuilder;
use Spiriit\PolirisBundle\Models\Annonce\Annonce;

$builder = new AnnonceExportBuilder();

$builder
    ->startLine()
    ->withIdentifiant('AGENCE001', 'PROP-12345', Annonce::ANNONCE_TYPE_VENTE, 'TECH-001')
    ->withType(type: 1, sousType: null)  // 1 = Apartment
    ->withLocalisation(cp: '75001', ville: 'Paris', pays: 'France', /* ... */)
    ->withSurface(surface: 65, nbPieces: 3, nbChambres: 2, /* ... */)
    ->withPrix(prix: 450000, /* ... */);

$csvContent = $builder->build()->toCSV();

Updated README to link to the professional documentation with clear, technical language throughout.

Original prompt

Rédige une section de documentation destinée aux développeurs pour le bundle Symfony “poliris-bundle”. La documentation doit comporter :

  1. Un guide “Getting Started” ultra clair, étape par étape, avec :

    • Un résumé de l’utilité du bundle
    • Les commandes d’installation avec composer
    • La configuration minimale pour débuter (avec exemple YAML)
    • Un exemple concret d’export de données immobilières
    • Une explication de ce à quoi ressemble le résultat (extrait CSV attendu)
  2. Des cas d’usage illustrés :

    • “Exporter pour SeLoger” avec exemple de mapping
    • “Inclure des photos” dans l’export
    • “Automatiser un export programmé” (ex : cron ou Event Symfony)
    • Exemple d’erreur courante et solution

Pense à illustrer chaque étape avec du code et, si possible, des schémas ou tableaux.
Adopte un style pédagogique, accessible, et visuel, adapté à un public développeur Symfony.

Génère le markdown directement, prêt à intégrer dans le README ou docs/ du repo.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Nov 16, 2025
…e cases

Co-authored-by: gilles-g <377875+gilles-g@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for poliris-bundle Add comprehensive French developer documentation for PolirisBundle Nov 16, 2025
Copilot AI requested a review from gilles-g November 16, 2025 07:39
@gilles-g

Copy link
Copy Markdown
Contributor

@copilot documentation uniquement en anglais et on appelle pas ça guide développeur, soit plus professionnel

Co-authored-by: gilles-g <377875+gilles-g@users.noreply.github.com>

Copilot AI commented Nov 16, 2025

Copy link
Copy Markdown
Contributor Author

@copilot documentation uniquement en anglais et on appelle pas ça guide développeur, soit plus professionnel

Documentation replaced with professional English version in commit 570e733. Changes:

  • Renamed from GUIDE_DEVELOPPEUR.md to DOCUMENTATION.md
  • All content translated to English
  • Professional title and link in README: "Complete Documentation"

Copilot AI changed the title Add comprehensive French developer documentation for PolirisBundle Add comprehensive developer documentation for PolirisBundle Nov 16, 2025
@gilles-g
gilles-g marked this pull request as ready for review November 20, 2025 12:52
@gilles-g
gilles-g merged commit ccd5bbe into main Nov 20, 2025
15 of 31 checks passed
@gilles-g
gilles-g deleted the copilot/update-poliris-bundle-documentation branch November 20, 2025 12:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants