Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation website #127

Open
Deadpikle opened this issue Nov 8, 2020 · 0 comments
Open

Improve documentation website #127

Deadpikle opened this issue Nov 8, 2020 · 0 comments

Comments

@Deadpikle
Copy link
Collaborator

Deadpikle commented Nov 8, 2020

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 have to manually update the docs by running the command line tool and push them to the branch that controls the website (gh-pages)
  • The website is not very pretty.
  • The docs aren't very...great....for example, enum values are not actually listed out. Maybe there is an option for this. I honestly didn't spend long on this haha

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant