Skip to content

v13 docs #110

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

Merged
merged 181 commits into from
May 7, 2025
Merged

v13 docs #110

merged 181 commits into from
May 7, 2025

Conversation

Mohammad-Alavi
Copy link
Member

No description provided.

@Mohammad-Alavi Mohammad-Alavi marked this pull request as ready for review May 6, 2025 09:02
@Mohammad-Alavi Mohammad-Alavi requested a review from Copilot May 6, 2025 09:03
@Mohammad-Alavi Mohammad-Alavi self-assigned this May 6, 2025
@Mohammad-Alavi Mohammad-Alavi added enhancement dependencies Pull requests that update a dependency file Typo wrong document Remove or fix a wrong information in the documentation broken link labels May 6, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation for v13 by replacing deprecated “generate” commands with the new “make” commands and updating the documentation links from GitHub to their new hosted locations. It also refines headings for consistency and removes outdated files.

  • Replaces command examples (e.g., apiato:generate:* → apiato:make:*) across multiple docs files.
  • Updates reference links to point to https://mahmoudz.github.io/Porto.
  • Removes obsolete documentation files, such as the events and request-lifecycle pages.

Reviewed Changes

Copilot reviewed 179 out of 185 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/components/optional-components/events.md Entire file removed; likely intentional clean-up.
docs/components/main-components/tasks.md Updated task command and refined headings and links.
docs/components/main-components/subactions.md Updated subaction command and related documentation.
docs/components/main-components/requests.md Updated request command; restructured and clarified sections.
docs/components/main-components/models.md Updated model command and added guidance on Resource Key usage.
docs/components/main-components/exceptions.md Updated exception command and clarified inheritance rules.
docs/components/main-components/controllers.md Updated controller command and refactored API controller for DI and Response facade usage.
docs/components/main-components/actions.md Updated action command and headings.
docs/architecture-concepts/request-lifecycle.md File removed as part of documentation cleanup.
docs/architecture-concepts/readme.md Updated link references.
docs/architecture-concepts/porto.md Revised title and content to reflect “Porto SAP”.
docs/architecture-concepts/container.md Updated title, command examples, and links.
docs/architecture-concepts/components.md Updated link references and removed extraneous tip note.
README.md Added acknowledgement section with sponsor details.
Files not reviewed (6)
  • docs/components/main-components/routes.mdx: Language not supported
  • docs/components/main-components/transformers.mdx: Language not supported
  • docs/components/main-components/views.mdx: Language not supported
  • docs/components/optional-components/commands.mdx: Language not supported
  • docs/components/optional-components/configs.mdx: Language not supported
  • docs/components/optional-components/events.mdx: Language not supported
Comments suppressed due to low confidence (3)

docs/components/optional-components/events.md:1

  • The file was completely removed. Please confirm that this removal is intentional and that any references to this documentation are updated accordingly.
Entire file removal

docs/components/main-components/controllers.md:72

  • [nitpick] Using dependency injection directly in the method signature promotes a cleaner approach. Ensure this style is consistent with dependency injection patterns used across other controllers in the project.
public function __invoke(SampleRequest $request, SampleAction $sampleAction)

docs/architecture-concepts/porto.md:3

  • With the title updated to 'Porto SAP', verify that all related documentation and internal references consistently reflect the new naming to avoid confusion.
title: Porto SAP

@Mohammad-Alavi Mohammad-Alavi merged commit 3a4496a into master May 7, 2025
3 checks passed
@Mohammad-Alavi Mohammad-Alavi deleted the feat/v13-docs branch May 7, 2025 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
broken link dependencies Pull requests that update a dependency file enhancement Typo wrong document Remove or fix a wrong information in the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant