Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add how-to for the most typical scenario #853

Closed
nojaf opened this issue Oct 24, 2023 · 2 comments
Closed

Add how-to for the most typical scenario #853

nojaf opened this issue Oct 24, 2023 · 2 comments

Comments

@nojaf
Copy link
Collaborator

nojaf commented Oct 24, 2023

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.

@SchlenkR
Copy link
Member

See here for a demo repo (PRs welcome):

https://github.com/RonaldSchlenker/FSDocsDemo

@nojaf
Copy link
Collaborator Author

nojaf commented Jan 26, 2024

@nojaf nojaf closed this as completed Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants