NetSparkleUpdater / NetSparkleUpdater/NetSparkle

Improve documentation website

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

Nobody has claimed this yet.

documentation enhancement help wanted research
Dominant language
C#
Stars
832
Forks
103
PR merge metrics
No merged PRs in 30d

Description

I wanted to get up a basic docs website so that people could browse properties and such on the various NetSparkleUpdater classes. I used Natural Docs (quick Google result 😅) to generate some OK docs, and they are up now on the website here. I like that it makes a single page docs app sort of thing. However, I really don't like this setup for a few reasons:

I would like to improve the docs on the website a lot, including integration of the details on this repo's README.md. I don't know what the options are here graphically. The repo also needs to be reconfigured (I think?) so that the docs website is a subfolder of the main repo instead of a separate branch so that CI/CD can generate and update the docs appropriately. There's some other files that get put on the website too so that the samples work, and we mustn't destroy any of those files or else the samples will stop working.

tl;dr: Need to get a better docs website up that can automatically update on CI/CD/repo push.

I'm open to suggestions!

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.

Research direction

Start by reviewing README.md, the existing documentation website, and the gh-pages branch to understand how generated docs and sample files are currently arranged. Define a CI/CD approach that incorporates README details, documents the C# classes and enum values, updates the site automatically, and preserves the files required by the samples.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.