Skip to content

docs: move composer install instructions to setup/install.md (#75) #236

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

Closed

Conversation

EmiFunes91
Copy link
Contributor

This pull request addresses issue #75 by moving the Composer installation instructions
from architecture/using-composer.md to setup/install.md, where they are more appropriately placed.

Changes made:

  • Relocated the composer create-project block and related instructions.
  • Updated architecture/using-composer.md to include a reference link to the new location.
  • Ensured Markdown formatting consistency and professional tone in both files.

Benefits:

  • Improves discoverability and structure of installation steps for new users.
  • Aligns with best practices for documentation organization.
  • Avoids duplication and makes maintenance easier.

Closes #75

Copy link
Member

@bennothommo bennothommo left a comment

Choose a reason for hiding this comment

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

Thanks for your interest in improving our docs @EmiFunes91. It does appear, however, that you have used an AI-assisted tool to generate these edits that unfortunately do not fit with our documentation structure. Please see the comments below to better implement these changes.

)

- Removed setup/install.md (duplicate location).
- Moved installation commands to setup/installation.md under new section.
- Added proper reference link in architecture/using-composer.md.
- Ensured Markdown consistency and heading structure.
- Resolves issue wintercms#75 as requested.
@EmiFunes91
Copy link
Contributor Author

EmiFunes91 commented May 13, 2025

Hi @bennothommo, thanks again for your detailed feedback.

I've now implemented all requested changes:

Removed the unnecessary markdown code block tag.

Moved both the Installing Winter via Composer and Configuring Winter sections to setup/installation.md, just below the Web-based Installation.

Removed the previously added setup/install.md file, as suggested.

All changes have been cleaned up and verified, and the conversations have been marked as resolved.

I’ve also responded to each individual comment and marked them as resolved after applying the requested changes.

Let me know if there's anything else to adjust — otherwise, it's ready for final review. Thanks again for the opportunity to contribute!

@EmiFunes91 EmiFunes91 requested a review from bennothommo May 13, 2025 03:20
- Removed redundant instructions from architecture/using-composer.md
- Linked to setup/installation.md instead
- Ensured clean structure and markdown compliance
Copy link
Contributor Author

@EmiFunes91 EmiFunes91 left a comment

Choose a reason for hiding this comment

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

Minor update: Changed my-winter-site to my-project to match the official installation guide at https://wintercms.com/install. Thanks again!

@bennothommo
Copy link
Member

bennothommo commented May 13, 2025

@EmiFunes91 thanks for your efforts, but unfortunately I cannot accept this PR in its current form, and it appears that you are using AI to make these edits, and it is not understanding the context of my suggestions. We'll go down a different route to implement the changes required to satisfy #75. Thanks again.

@EmiFunes91
Copy link
Contributor Author

Understood, thank you for your time and feedback.
I appreciate the opportunity to contribute and I understand the importance of aligning with the project’s structure and expectations.
I’ve learned a lot from this process and hope to support the Winter CMS project again in the future.

@EmiFunes91 EmiFunes91 deleted the fix/move-composer-install-docs branch May 13, 2025 20:24
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.

Move composer installation commands to install section of docs
2 participants