We should add a short guide on how to set up the most common scenario for people to use this tool.
We could benefit from a step-by-step guide on how to go from a first Markdown file in the docs folder to a published GitHub pages website.
Something along the lines of:
Install the commandline tool
Create the docs folder with a first index.md file.
Update your Directory.Build.props file with some recommendations.
Launch the tool locally to see what it looks like.
Enable GitHub pages (screenshot)
Create a GitHub Action yaml. (Build the docs, upload them as artifact, deploy the artifacts)
Profit!
I think this could encourage more projects to add documentation.
We should add a short guide on how to set up the most common scenario for people to use this tool. We could benefit from a step-by-step guide on how to go from a first Markdown file in the
docs
folder to a published GitHub pages website.Something along the lines of:
docs
folder with a firstindex.md
file.Directory.Build.props
file with some recommendations.I think this could encourage more projects to add documentation.