Skip to content

docs: enhance README with instructions and helpers section#493

Open
cedric07 wants to merge 1 commit intomasterfrom
feat/doc
Open

docs: enhance README with instructions and helpers section#493
cedric07 wants to merge 1 commit intomasterfrom
feat/doc

Conversation

@cedric07
Copy link
Copy Markdown
Contributor

@cedric07 cedric07 commented Apr 27, 2026

Pour faire suite à cette card : https://www.notion.so/beapi/Documentation-technique-BFF-et-BBT-2140865393b98043a207e12da097b791?v=28b1760024c04863922bd6a44b0ee494&source=copy_link


Note

Low Risk
Low risk: documentation-only changes with no runtime or build logic modifications; main risk is minor confusion if examples drift from actual helper behavior.

Overview
Expands README.md with a new Formatting helpers section documenting how to use the theme’s namespaced helper functions (Image, Link, Share, Term, Text, and SVG sprites), including example calls, expected HTML output, and related filters.

Clarifies Composer PSR-4 autoload mapping for inc/, updates the dev workflow section to explicitly document yarn start/yarn build plus new lint commands (yarn lint:css, yarn lint:js, yarn lint), and adds an illustrative example of merged bff_editor_custom_settings output.

Reviewed by Cursor Bugbot for commit cb4e045. Bugbot is set up for automated code reviews on this repo. Configure here.

@cedric07 cedric07 requested a review from francoistibo April 27, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant