Humanizer icon indicating copy to clipboard operation
Humanizer copied to clipboard

Humanize.NET site contents out of sync with repository

Open SeanKilleen opened this issue 4 years ago • 3 comments

The contents of the README differ from what is published on https://humanizr.net/

It looks like there may not be an automated build process for the docs. It may be worth pulling the contents into a “docs” folder and creating a GitHub action to pick up on changes and rebuild the site.

I’m a little swamped at the moment to do the PR, but if you’re interested, let me know. 👍

SeanKilleen avatar Jun 23 '20 14:06 SeanKilleen

Happy to have an action to keep the docs up to date!

clairernovotny avatar Aug 31 '20 14:08 clairernovotny

@clairernovotny I looked into this briefly to see what would be required.

At this point, I think the site uses OOTB GitHub pages theme and so I think you could do the following:

  • Add the CNAME file with humanizr.net into the master branch.
  • Switch gh-pages to build with the architect theme and use the master branch as your source.
  • Ensure the publish is successful. My understanding is gh-pages will publish the README.md file as the index and it should be good to go.
  • Delete the gh-pages branch.

As far as I can tell, any custom HTML, styling, JS, etc. mirrors the existing theme.

I would be happy to contribute to this except that GitHub Pages requires updates to repo settings. If you're willing to give me the access, I'm willing to see this through to completion. Thanks!

SeanKilleen avatar Apr 02 '21 15:04 SeanKilleen

@SimonCropp I think this might be useful for you to do as part of the reboot -- seems like a quick win.

If you're willing to grant me the access to do it I'm happy to work to make it happen -- at that point someone could add the CNAME in DNS and it should switch over. This way we can check that it works first as well, which is nice.

SeanKilleen avatar Mar 01 '24 14:03 SeanKilleen