microsoft / microsoft/Documentarian

Review and update reference documentation for the modules

Open
#119 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentarian Documentarian.DevX Documentarian.MarkdownLint Documentarian.MicrosoftDocs Documentarian.ModuleAuthor Documentarian.Vale documentation maintenance
Dominant language
PowerShell
Stars
50
Forks
16
Avg merge
3h 54m
Merged PRs (30d)
2

Description

Prerequisites
  • Accepted Idea: Proposals in this project are created based on ideas that have been marked as Accepted in their Discussion. Before you file an issue for a feature or change, create a discussion. If you file an issue without a discussion, the team may convert it into one.
  • Existing Issue: Search the existing issues and discussions for this repository. If there is an issue or discussion that fits your needs do not file a new one. Subscribe, react, or comment on that issue or discussion instead.
  • Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Add Get-Foo cmdlet to Documentarian module" instead of "New cmdlet."
Module

Documentarian, Documentarian.DevX, Documentarian.MarkdownLint, Documentarian.MicrosoftDocs, Documentarian.ModuleAuthor, Documentarian.Vale

Summary

As a user, I want up-to-date reference documentation for the commands, classes, and enums that a module exports, so that I can understand what they do and how I can use them.

Details

We need to go through each of the modules and ensure that the reference documentation for their public code is fully documented.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the six listed modules—Documentarian, Documentarian.DevX, Documentarian.MarkdownLint, Documentarian.MicrosoftDocs, Documentarian.ModuleAuthor, and Documentarian.Vale—and their existing reference documentation. Identify exported commands, classes, and enums that lack complete documentation; done means the public code in every listed module has up-to-date reference documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.