schlenkr / fsdocsdemo

A repo for demonstrating a minimal FSharp.Formatting use case with GH pages

Hello Everyone 👋

F# ❤️ Developer | Tech Consultant | OSS Creator | Conference Speaker

Recognized F# Expert

Learning

If you wanna know a little bit more than the usual stuff, if you wanna level up your skills and change your way of thinking about programming, then visit my YouTube channel The Pure State!

👍Postman? ❤️ FsHttp!

https://youtu.be/F508wQu7ET0

What I do

Build software that is performant, maintainable over years, scalable and affordable.

Helping people to improve skills together.

🚀 As a freelancer, you can hire me.

☎️ Contact me on 👉🏼 Twitter

📖 Exchanging knowledge and discourse are valuable.

Technologies

Although techologies, stacks, tools matter, it's the first sentence from the list above that really matters. For anything else:

• .Net, C#, JavaScript, TypeScript, and many, many more buzzwords on a daily basis.
• Interested in the next level of development? Let's do some real-world F# together.

OSS Development

Creator of Vide - For Reactive UIs (Web / Desktop / Mobile), Digital Signal Processing and More!

Creator of FsHttp - A lightweight C# and F# HTTP library

Creator of The Blunt - A a one-file recursive descent parser combinator library for F# and Fable.

Creator of Trulla Templates - It's like Handlebars or Mustache, but statically typed and safe!

fsdocsdemo's Issues

Everything wrong with this repository!

Oh hi Ronald, I'm here to nitpick, brace yourself so let's go:

• If this sample is meant to present the bare minimum then you should drop anything that adds additional noise:
  • No PowerShell, you can do everything with the cross-plat dotnet cli.
  • No .devcontainer, no everybody knows about them.
  • No extra build folder, docs.ps1 contains too many arguments. You can stick to the defaults instead. (More on that later)
• Creating content hints at placing everything in the docs folder. This is the case for some many projects, so I really discourage that you use src/docs instead. Just yuck man.
• Add a solution file, if people ever want to open this, it is a convenient way and helps when working with Rider. Opening a folder is more of a VSCode-only thing. I don't know how well VS works with that. Anyway a single top-level solution has my preference.
• Use a Build.Directory.props file to specify some settings. See Customizing via Styling Parameters. This is again an alternative for --sourcerepo. The only command you want to end up with are dotnet fsdocs build and dotnet fsdocs watch which are short enough to type.
• Your actions/ use old versions. Like checkout and setup-dotnet
• Add a link to your result to the home page: https://ronaldschlenker.github.io/FSDocsDemo/ (configure this in github as well)