LSDHH Documentation made with MkDocs and Material for MkDocs

Overview

The LSDHH Documentation guide is made with MkDocs and Material for MkDocs. Documentation is written in markdown. All markdown files are saved in the /docs directory. Images are saved in the /img folder inside /docs. See Material for MkDocs

There's an excellent overview video on installing and setting up MkDocs and Material for MkDocs, in general, on YouTube: How To Create STUNNING Code Documentation With MkDocs Material Theme.

View the LSDHH Documentation guide on Github.io LSDHH Documentation

Contribute to LSDHH Documentation

Clone the Repo, Make Changes on Branches, Submit Pull Requests

1. Clone the repo.
2. Create a branch.
3. Make changes and commit to your branch.
4. Push changes to GitHub.
5. Create a pull request.
6. Assign to someone for review.
7. Changes will be reviewed and approved or rejected.

Edit on GitHub and Submit Pull Requests

1. Browse the repo and find a document.
2. Click the "edit" button for the document.
3. Fork the repository.
4. Make changes in the document.
5. Click "commit changes" button.
6. Write a commit message.
7. Click "propose changes" button.
8. Click the "create pull request" button.
9. Assign to someone for review.
10. Changes will be reviewed and approved or rejected.