Create github action for updating xsd and api docs (sandcastle)?

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
65/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, powershell

Research direction

Start from the linked scripts/update-xsd-file.ps1 and list what it reads, runs and writes before creating any workflow. Then inspect how the site's XSD and API docs are currently generated and where the output belongs. Done means a GitHub Actions workflow that runs the same update steps and leaves the regenerated docs in the repository or a pull request.

Written by the indexing model from the issue text.

Description

Dominant language
HTML
Stars
6
Forks
24
Avg merge
5m
Merged PRs (30d)
3

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 NLog/NLog.github.io

All issues in NLog/NLog.github.io

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.