Skip to content

📖 [Docs]: Update to docs #113

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 4 commits into from
Apr 19, 2025
Merged

📖 [Docs]: Update to docs #113

merged 4 commits into from
Apr 19, 2025

Conversation

MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Apr 19, 2025

Description

This pull request updates the README.md file to improve documentation for a PowerShell module build process. The changes include adding a new step to the build process, clarifying repository structure expectations, and renaming a section for better clarity.

Documentation Updates:

  • Added a new step to the build process: Documented the step that uploads the module artifact for use in subsequent workflow steps. (README.md, README.mdR25)
  • Defined expected repository structure: Added a section describing the expected repository structure, referencing the Template-PSModule repository as an example. (README.md, README.mdR40-R43)
  • Renamed "Sources" section to "References": Updated the section title to better reflect its purpose. (README.md, README.mdL154-R159)

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@Copilot Copilot AI review requested due to automatic review settings April 19, 2025 10:01
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner April 19, 2025 10:01
Copy link
Contributor

@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 pull request updates the documentation in the README.md file to improve clarity around the PowerShell module build process. Key changes include:

  • Adding a new step for uploading the module artifact.
  • Introducing an "Expected repository structure" section with a reference to Template-PSModule.
  • Renaming the "Sources" section to "References" to better reflect its purpose.

@MariusStorhaug MariusStorhaug moved this from 🆕 New to 🏗 In progress in PSModule Framework Apr 19, 2025
@MariusStorhaug MariusStorhaug self-assigned this Apr 19, 2025
MariusStorhaug and others added 2 commits April 19, 2025 12:10
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MariusStorhaug MariusStorhaug requested a review from Copilot April 19, 2025 11:02
Copy link
Contributor

@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 improves the documentation for the PowerShell module build process by updating the README with clearer instructions and revised sections.

  • Added a new step documenting the upload of the module artifact.
  • Introduced an "Expected repository structure" section referencing Template-PSModule.
  • Renamed the "Sources" section to "References" and updated related comments in the module manifest sample.

@MariusStorhaug MariusStorhaug merged commit 3f9d3e8 into main Apr 19, 2025
1 check passed
@MariusStorhaug MariusStorhaug deleted the docs branch April 19, 2025 11:03
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in PSModule Framework Apr 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

1 participant