statiqdev / Website

Code for the statiq.dev website, built with Statiq.
MIT License
21 stars 34 forks source link

QuickStart Documentation could do with a few extra bits of information #60

Open petebannister opened 3 years ago

petebannister commented 3 years ago

Have been looking into Statiq to see if it will work for a project I'm doing. Its looking very promising! I've used Hugo before but much prefer the look of the Razor templates and this should also allow some more complex stuff I'm hoping to be able to do.

Have had a few initial issues that are probably obvious but not having done any asp.net or Razor development before were not initially obvious for me:

1) If you are running preview mode on the site then if you change settings.yml then the changes are not picked up! I realise now that this must be because they are more of a fundamental .net thing that's done at startup. But I spent a lot of time trying to figure out why some custom items were showing up and some weren't!

2) Possibly this was due to 1) but the Layout setting was not working for me in settings.yml. I was trying to set up a theme and could not get the layout working for a couple of hours! But adding _ViewStart.cshtml made it work. If this is something that's necessary (I see it is used on your staticdev site) then would be good to document that for beginners. And perhaps also mention that the server needs restarting after adding the theme.

3) Is there a verbose mode that will output warning when calling GetString for keys that do not exist? And perhaps even detect that settings.yml changed and suggest restarting the server? A bit more of a walkthrough on setting up a theme would be amazing.

4) How do you purchase a license? There's a lot of info in the Licensing FAQ but I couldn't see any obvious 'pay here' links there. I want to use this to generate a help system for a commercial product - presumably that means a license is required?

daveaglick commented 2 years ago

Great feedback! I've totally reworked the documentation site so maybe that'll help (hence the radio silence - the site has been "under construction" on this new version for a long time). I'm also going to move this issue over to the docs repo for a closer look.