NetSparkleUpdater/NetSparkle

Improve documentation website

开放

#127 创建于 2020年11月8日

 (0 条评论) (0 个反应) (0 位负责人)C# (101 个派生)auto 404
documentationenhancementhelp wantedresearch

仓库指标

星标
 (822 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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!

贡献者指南