Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use PHPDoc for Task & Transformer Reference #159

Open
2 tasks
njoubert-cleverage opened this issue Feb 20, 2025 · 0 comments
Open
2 tasks

Use PHPDoc for Task & Transformer Reference #159

njoubert-cleverage opened this issue Feb 20, 2025 · 0 comments

Comments

@njoubert-cleverage
Copy link
Member

From #125

Description

Today, reference documentation is lacking a lot of information, and some might be quickly obsolete...

The goal of this PR is to put a maximum of documentation right into PHPDoc

  • more visibility for people looking into code
  • less risk of difference between the code & doc

I tried to use https://phpdoc.org/ to generate a static website to help peeking into content.
image

There's still on-going documentation work. Some customization has been added in the .phpdoc folder

Requirements

  • Documentation updates
    • Reference : push more and more task / transformer reference into PHPDoc and remove the old .md file
    • Find some hosting solution
    • Cookbooks
    • Changelog
  • Unit tests

Implementation notes

To build the doc, use make build/sf4 doc

Breaking changes

None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant