Merge pull request #371 from Real-MullaC/patch-7

Docs Update
This commit is contained in:
Chris Titus 2024-09-16 15:11:21 -05:00 committed by GitHub
commit 5679ea0ae8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 11 additions and 4 deletions

4
.github/mkdocs.yml vendored
View File

@ -5,7 +5,9 @@ docs_dir: '../docs'
nav:
- Introduction: 'index.md'
- User Guide: 'userguide.md'
- Contributing Guide: 'contribute.md'
- Contributing:
- Contributing Guide: 'contribute.md'
- Roadmap: 'roadmap.md'
- Documentation:
- Known Issues: 'KnownIssues.md'
- FAQ: 'faq.md'

View File

@ -3,10 +3,11 @@ name: GitHub Pages Deploy
on:
push:
paths:
- 'mkdocs.yml'
- '.github/mkdocs.yml'
- '.github/requirements.txt'
- 'docs/**'
- 'overrides/**'
- 'CONTRIBUTING.md'
- '.github/CONTRIBUTING.md'
workflow_dispatch:
jobs:
@ -29,4 +30,6 @@ jobs:
run: pip install -r .github/requirements.txt
- name: Build & Deploy using mkdocs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: mkdocs gh-deploy --force -f .github/mkdocs.yml

View File

@ -31,7 +31,9 @@ For comprehensive information on how to use Linutil, visit the [Linutil Official
## 🛠 Contributing
We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](CONTRIBUTING.md) to understand how to make the most effective and efficient contributions.
We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](.github/CONTRIBUTING.md) to understand how to make the most effective and efficient contributions.
[Official LinUtil Roadmap](https://christitustech.github.io/linutil/roadmap)
## 🏅 Thanks to All Contributors