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

Minor: Add automatic documentation generation #20

Merged
merged 3 commits into from
Apr 19, 2024
Merged

Conversation

fslef
Copy link
Member

@fslef fslef commented Apr 19, 2024

Pull Request

Pull Request (PR) description

Added

  • Automatic documentation generation and publication to GitHub Wiki

Task list

  • The PR represents a single logical change.
  • Added an entry under the Unreleased section of in the CHANGELOG.md as per format.
  • Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency).
  • Documentation added/updated in src/WikiSource.
  • Comment-based help added/updated to any .ps1 files..
  • Unit tests added/updated. See CyberShell Module Testing Guidelines.
  • Integration tests added/updated (where possible). See CyberShell Module Testing Guidelines.

@fslef fslef changed the title Minor: Add documentation automatic Generation Minor: Add automatic documentation generation Apr 19, 2024
Copy link

MacOs Test Results

40 tests   40 ✅  6s ⏱️
 7 suites   0 💤
 1 files     0 ❌

Results for commit b05eb57.

Copy link

Linux Test Results

40 tests   40 ✅  2s ⏱️
 7 suites   0 💤
 1 files     0 ❌

Results for commit b05eb57.

Copy link

WinPS71 Test Results

40 tests   40 ✅  4s ⏱️
 7 suites   0 💤
 1 files     0 ❌

Results for commit b05eb57.

@fslef fslef marked this pull request as ready for review April 19, 2024 09:56
@fslef fslef merged commit c7db66e into main Apr 19, 2024
9 checks passed
@fslef fslef deleted the feat/docGenerator branch April 19, 2024 09:56
fslef added a commit that referenced this pull request Apr 19, 2024
* Added DscResource.DocGenerator and PlatyPS modules

* Add documentation genetation and publication tasks

* Add automatic documentation generation and publication to GitHub Wiki

Fix Changelog

fix publish wiki

Update GitHubConfigUserName and GitHubConfigUserEmail in build.yaml

Update build.yaml with GitHub Wiki and sidebar configuration

Update build.yaml with GitHub Wiki and sidebar configuration

Update build.yaml with GitHub Wiki and sidebar configuration

Refactor automatic documentation generation and publication
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