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

Enhance PHP API REF metadata #2575

Merged
merged 7 commits into from
Dec 11, 2024
Merged

Enhance PHP API REF metadata #2575

merged 7 commits into from
Dec 11, 2024

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Dec 10, 2024

Question Answer
JIRA Ticket
Versions master, 4.6
Edition
  • Enhance <title> tag, closer to main doc one; prepend namespace, interface and class names to it.
  • Add <meta name="description" content="{{ node.summary }}" /> to interface and classes.

Example with Ibexa\Contracts\Core\FieldType\FieldType abstract class:

BeforeAfter
<title>PHP API Reference</title> <title>FieldType | PHP API Reference (Ibexa Documentation)</title> <meta name="description" content="The field type interface which all field types have to implement." />

Example with Ibexa\Contracts\Core\FieldType namespace:

BeforeAfter
<title>PHP API Reference</title> <title>FieldType | PHP API Reference (Ibexa Documentation)</title>

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

@adriendupuis adriendupuis marked this pull request as ready for review December 11, 2024 11:53
@adriendupuis adriendupuis merged commit 14fba98 into master Dec 11, 2024
3 of 5 checks passed
@adriendupuis adriendupuis deleted the php-api-ref-meta branch December 11, 2024 12:31
adriendupuis added a commit that referenced this pull request Dec 11, 2024
* .phpdoc/template: Enhance <title>
* .phpdoc/template: Add meta description
* Generate PHP API Ref HTML

(cherry picked from commit 14fba98)
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