Set up workflow to auto generate C# API documentation

Open
#45 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
ci-cd, documentation

Research direction

Start with the Flow.Launcher.Plugin project and the deployment process, then review XmlDocMarkdown's instructions for generating C# API documentation. The manual-generation guidance describes creating a console project that references Flow.Launcher.Plugin. Done means the documentation is generated automatically on each new deployment of Flow's API.

Written by the indexing model from the issue text.

Description

enhancement

Set up workflow to auto generate C# API documentation on each new deployment of flow's API.

Use:
https://ejball.com/XmlDocMarkdown/

Manual generation:
Create a console project reference back to the Flow.Launcher.Plugin project, and follow the instruction to generate the document.

Dominant language
Svelte
Stars
23
Forks
23
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from Flow-Launcher/docs

All issues in Flow-Launcher/docs

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.