Skip to content

Update documentation#102

Merged
yeu1 merged 1 commit into
masterfrom
documentation
May 7, 2026
Merged

Update documentation#102
yeu1 merged 1 commit into
masterfrom
documentation

Conversation

@yeu1
Copy link
Copy Markdown
Contributor

@yeu1 yeu1 commented May 6, 2026

No description provided.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

Caution

Review failed

Failed to post review comments

Walkthrough

This pull request reorganizes and enhances documentation for the Penneo PHP SDK. The main README is updated with references to a new comprehensive CLI examples documentation file located at docs/cli-examples.md. The interactive OAuth example is substantially rewritten to implement a complete OAuth PKCE flow with environment variable configuration, error handling, and token storage. The programmatic OAuth example receives a debugging output addition. Documentation paths are updated to reflect examples moving from the examples/ directory to the docs/ directory. The previous CLI examples README content is removed, with its documentation consolidated into the new centralized CLI examples file.

🚥 Pre-merge checks | ✅ 2 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update documentation' is vague and generic, lacking specificity about what documentation changes are being made. Consider a more descriptive title that specifies the main documentation changes, such as 'Reorganize CLI examples and add interactive OAuth demo' or 'Move CLI examples to docs directory with enhanced examples'.
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether the description relates to the changeset. Add a pull request description that explains the purpose and scope of the documentation changes, including the reorganization of CLI examples and new OAuth demonstrations.
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 PHPStan (2.1.54)

PHPStan was skipped because the sandbox runner could not parse its output.

🔧 Microsoft Presidio Analyzer (2.2.362)
README.md

Microsoft Presidio Analyzer failed to scan this file


Comment @coderabbitai help to get the list of available commands and usage tips.

@yeu1 yeu1 requested a review from HeadCookie May 6, 2026 14:49
@yeu1
Copy link
Copy Markdown
Contributor Author

yeu1 commented May 7, 2026

@coderabbitai re-review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Tip

For best results, initiate chat on the files or code changes.

@yeu1 Sure! I'll re-review the changes in this PR right away.

[full_review]

Copy link
Copy Markdown

@armino-dev armino-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏼

@yeu1 yeu1 merged commit dc3177a into master May 7, 2026
19 checks passed
@yeu1 yeu1 deleted the documentation branch May 7, 2026 08:45
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.

2 participants