nimdocs.com going away

[guzba]

Hello, I wanted to give this repo a quick heads-up that nimdocs.com, which @treeform and I have been running, is going away in favor of using Github Actions + Github Pages.

nimdocs.com is currently linked to from this repo's readme for documentation.

My suggestion:

Add this Github Actions workflow file: https://github.com/treeform/nimtemplate/blob/master/.github/workflows/docs.yml (no need to change anything) to automatically generate docs in a branch called gh-pages. This branch will have the Docs content updated each push.

In the repo settings Page tab, you can then select that branch to serve (once the job has run once).

After that, https://nim-lang.github.io/bigints/ should be serving the most recently generated docs.

This is simpler than us running a server and all of that stuff and just as easy for repo maintainers so I think it is a better model.

I'll keep the server up for a bit yet but it is going away.

[dlesnoff]

@guzba Thanks for the notification, I am going to make a PR tonight.

[pietroppeter]

Still to do:

• [x] activate GitHub pages in the repo (they are not active otherwise the GitHub.io link above would work)
• [ ] update link to docs in the readme

[dlesnoff]

@narimiran Can you activate the GitHub pages in the repo? My PR broke the YAML file.

[narimiran]

It should be activated now. Please let me know if it doesn't work.

[dlesnoff]

Thanks for the activation. I can indeed read the README.md file at the given link. Yet, I can not read the documentation of the library. I will look that up later.

[konsumlamm]

@narimiran did you select the gh-pages branch for deployment (Settings -> Pages -> Branch)?

[narimiran]

@narimiran did you select the gh-pages branch for deployment (Settings -> Pages -> Branch)?

Now I did :)

[konsumlamm]

Nice, now it works.

[dlesnoff]

Thanks for fixing that!