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

As a module developer, I want to generate markdown documents for commands and the module, so that I can create the MAML help file #54

Open
4 tasks
aldrichtr opened this issue Oct 31, 2023 · 0 comments
Labels
story.user A user story for this project

Comments

@aldrichtr
Copy link
Owner

aldrichtr commented Oct 31, 2023

Definition of Done

The Build phase of the docs profile creates the external help xml file in the staging directory for each module

Acceptance Criteria

  • GIVEN a directory of properly formatted markdown files in the docs/<module name> directory, WHEN the build task is run, THEN the <module name>-help.xml file is created in the en-US directory in staging AND any additional language

Tasks

  • Create a docs build profile
  • Create a task that generates a markdown file for each function
  • Create a task that updates the markdown based on the comment-based help
  • Create a task that fixes the language on codeblocks in PlatyPS
@aldrichtr aldrichtr changed the title Create workflow for building module documentation As a module developer, I want to generate markdown documents for commands and the module, so that I can create the MAML help file Dec 10, 2023
@aldrichtr aldrichtr added the story.user A user story for this project label Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story.user A user story for this project
Projects
None yet
Development

No branches or pull requests

1 participant