docs update

Author: goel4ever

README.md

@@ -11,8 +11,8 @@ Feel free to use this template by clicking on `Use this template` button.
 - Ready to use template
 - Stand up a static website in seconds
 - Uses material-UI plugin to follow standard UI elements
-- Built in search support
-- GitHub workflow setup already to deploy to Gh-pages
+- Built-in search support
+- Automatic deployment to gh-pages using GitHub workflow
 
 ### Tips
 
@@ -21,9 +21,40 @@ Feel free to use this template by clicking on `Use this template` button.
   - Previous: `p`
   - Next: `n`
 
-## Installation Instructions
+## How to use the template
 
-Go [here](./docs/local-development.md) for instructions
+### Creating a repo
+
+Click on `Use this template` green button from the [repository](https://github.com/goel4ever/mkdocs-template) to create your own repository in a desired github account.
+
+### Updating configuration
+
+Now, update the following fields in `mkdocs.yml` file
+
+- `repo_url` - path to your new repo
+- `site_url` - path where GitHub will deploy your new site, or your domain if you have one
+- `homepage` - path where GitHub will deploy your new site, or your domain if you have one
+- `property` - if you need analytics, you can replace the google analytics tag for your repo with your own. Otherwise remove the `analytics` section completely
+
+### Files Cleanup
+
+- `docs` folder is meant to provide some guidelines for contributing to the project. It is unrelated to newer projects, however feel free to use it if needed.
+- `help` folder is meant to help you understand how to best use the template, and provide help if you feel stuck somewhere. If you don't need it, feel free to get rid of it, since you can always refer back to the original template.
+- Update `README.md` file with your own content, based on what you intend to document
+
+### Optional changes
+
+1. You can update your new site's icon by replacing the image `logo.png` from `/src/assets/images`. As of now, we only use `logo.png`, feel free to get rid of other files.
+2. Add your website's url on your github repository for easy access
+3. Add tags on your github repository if interested
+
+### Deploy the website
+
+Nothing needs to be done here. Your GitHub workflow will take care of pushing the changes out to gh-pages automatically once you commit your new changes
+
+## Help
+
+There is good documentation [here](./docs/local-development.md) for tasks that may be helpful. Feel free to check it out.
 
 ## Contribution
 

docs/README.md

@@ -1,17 +1,9 @@
 # Template Documentation
 
-Documentation for specific needs
+Yet to update:
 
-1. [Local Development](local-development.md)
-2. [Hosting the site](./hosting-site.md)
-3. [Choosing Theme](choosing-theme.md)
-4. [Starting a new project](./new-project.md)
-5. [Contributing](./CONTRIBUTING.md)
+1. [Contributing](./CONTRIBUTING.md)
 
 ## References
 
-- MkDocs [official site](https://www.mkdocs.org/getting-started/)
-- [Writing your docs](https://www.mkdocs.org/user-guide/writing-your-docs/)
-- MkDocs [Alternatives](https://squidfunk.github.io/mkdocs-material/alternatives/)
-- [Deploying the docs](https://www.mkdocs.org/user-guide/deploying-your-docs/)
 - GitHub [Guidelines](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)

help/README.md

@@ -0,0 +1,16 @@
+# Help
+
+Helpful documents for specific needs:
+
+1. [Local Development](local-development.md)
+2. [Adding Tags](./adding-tags.md)
+3. [Hosting the site](./hosting-site.md)
+4. [Choosing Theme](choosing-theme.md)
+5. [Starting a new project](./new-project.md)
+
+## References
+
+- MkDocs [official site](https://www.mkdocs.org/getting-started/)
+- [Writing your docs](https://www.mkdocs.org/user-guide/writing-your-docs/)
+- [Deploying the docs](https://www.mkdocs.org/user-guide/deploying-your-docs/)
+- MkDocs [Alternatives](https://squidfunk.github.io/mkdocs-material/alternatives/)

help/adding-tags.md

@@ -0,0 +1,26 @@
+# Adding Tags
+
+Tags help group content, esp when using search functionality. Feel free to add some on desired pages.
+
+## How do I add a tag?
+
+Add the tags in desired `*.md` file in the following format:
+
+```
+---
+tags:
+  - mkdocs
+  - template
+  - python
+---
+```
+
+## How do I know it's working?
+
+As an example, go [here](https://goel4ever.github.io/mkdocs-template/). Type `mkdocs` in the search bar. You'll see the tags above show up right below document recommendation.
+
+Similaryly, go to your website and search for the tags you added.
+
+## Can I search the docs by tag?
+
+Unfortunately, not at the moment. I haven't had a chance to figure that out yet. Keep an eye on updates coming to this template repository. Alternatively feel free to contribute by creating a PR for it.

docs/choosing-theme.md help/choosing-theme.mddocs/choosing-theme.md renamed to help/choosing-theme.md

@@ -1,6 +1,6 @@
 # Hosting Site built
 
-This repository has GitHub workflow setup, which will automatically upload changes to GitHub pages on merge to `main` branch. No additional action needed.
+> Note: This repository has GitHub workflow setup, which will automatically upload changes to GitHub pages on merge to `main` branch. No additional action needed.
 
 However, in case there is a need to do it manually, below are a few options: