chore: enhance documentation and streamline project structure

SirStig · SirStig · commit 9e5470506f66 · 2025-08-23T13:44:50.000-06:00
- Added a star request button in README for visibility
- Verified documentation build process with `mkdocs build --strict`
- Updated documentation dependencies to latest versions
- Enhanced CONTRIBUTING.md with documentation build requirements
- Fixed mkdocs navigation and relative link issues
- Removed Acknowledgments section from README for a cleaner appearance
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -48,6 +48,7 @@ Describe the tests that have been performed to verify the changes. Include instr
 - [ ] Integration tests pass
 - [ ] Manual testing performed
 - [ ] Performance testing (if applicable)
+- [ ] Documentation builds correctly (`mkdocs build --strict`)
 
 ### Test Instructions
 
@@ -71,6 +72,7 @@ Describe the tests that have been performed to verify the changes. Include instr
 - [ ] No new linting warnings introduced
 - [ ] Type hints added where appropriate
 - [ ] Error handling implemented appropriately
+- [ ] Documentation is accurate and up-to-date
 
 ## Breaking Changes
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,7 +9,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Placeholder for future features
+- Star request button prominently displayed in README
+- Documentation build verification with `mkdocs build --strict`
+
+### Changed
+
+- Updated documentation dependencies to latest versions
+- Enhanced CONTRIBUTING.md with documentation build requirements
+- Updated development setup to include docs dependencies
+
+### Fixed
+
+- Fixed mkdocs navigation configuration to include all existing documentation files
+- Resolved relative link issues in documentation
+- Fixed missing file warnings in mkdocs build
+
+### Removed
+
+- Acknowledgments section from README.md (streamlined for professional appearance)
 
 ## [0.2.0] - 2024-01-15
 
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -36,7 +36,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT EMAIL]. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at conduct@projectyoked.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -26,7 +26,7 @@ We welcome contributions to YokedCache! This document provides guidelines for co
 
 3. **Install development dependencies:**
    ```bash
-   pip install -e ".[dev]"
+   pip install -e ".[dev,docs]"
    ```
 
 4. **Install pre-commit hooks:**
@@ -98,6 +98,9 @@ pytest tests/test_cache.py::TestYokedCache::test_basic_get_set
 - Follow Google-style docstring format
 - Update README.md for new features
 - Add examples to the `examples/` directory
+- Update documentation in `docs/` directory as needed
+- Run `mkdocs build --strict` to verify documentation builds correctly
+- Test documentation locally with `mkdocs serve`
 
 ## Contribution Guidelines
 
@@ -138,6 +141,7 @@ For new features:
    black src tests examples
    flake8 src tests examples
    mypy src --ignore-missing-imports
+   mkdocs build --strict
    ```
 
 6. **Commit your changes** with a clear commit message:
diff --git a/README.md b/README.md
@@ -2,13 +2,19 @@
 
 High-Performance Caching for Modern Python Applications
 
+<div align="center">
+
+[![⭐ Star YokedCache](https://img.shields.io/github/stars/sirstig/yokedcache?style=for-the-badge&logo=github&logoColor=white&color=yellow)](https://github.com/sirstig/yokedcache/stargazers)
+
 [![PyPI version](https://img.shields.io/pypi/v/yokedcache.svg)](https://pypi.org/project/yokedcache/)
 [![Python](https://img.shields.io/pypi/pyversions/yokedcache.svg)](https://pypi.org/project/yokedcache/)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![Tests](https://github.com/sirstig/yokedcache/actions/workflows/test.yml/badge.svg)](https://github.com/sirstig/yokedcache/actions/workflows/test.yml)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/yokedcache)
 
+</div>
+
 Intelligent caching with automatic invalidation, fuzzy search, and seamless FastAPI integration.
 
 **[Documentation](https://sirstig.github.io/yokedcache)** | **[Report Bug](https://github.com/sirstig/yokedcache/issues)** | **[Request Feature](https://github.com/sirstig/yokedcache/issues)**
@@ -377,15 +383,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-## Acknowledgments
-
-- [Redis](https://redis.io/) - For the excellent caching backend
-- [FastAPI](https://fastapi.tiangolo.com/) - For the amazing Python web framework  
-- [SQLAlchemy](https://www.sqlalchemy.org/) - For database ORM integration
-- Python Community - For continuous inspiration and feedback
-
 ---
 
 **Made with care by [Project Yoked LLC](https://github.com/sirstig)**
-
-If YokedCache helps your project, please consider giving it a star on GitHub!
diff --git a/docs/index.md b/docs/index.md
@@ -76,7 +76,7 @@ Command-line tools and utilities:
 ### 📖 **Reference**
 Detailed technical documentation:
 
-- **[API Reference](api/)** - Complete API documentation
+- **[API Reference](api/index.md)** - Complete API documentation
 - **[Performance Guide](performance.md)** - Optimization and tuning
 - **[Security Guide](security.md)** - Security best practices
 - **[Troubleshooting](troubleshooting.md)** - Common issues and solutions
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,24 +49,21 @@ markdown_extensions:
 nav:
   - Home: index.md
   - Getting Started: getting-started.md
-  - Concepts: concepts.md
-  - Usage Guide: usage.md
-  - Auto-Invalidation: auto-invalidation.md
-  - Keys & Serialization: keys-serialization.md
-  - Fuzzy Search: fuzzy-search.md
-  - Redis Setup: redis-setup.md
+  - Core Concepts: core-concepts.md
+  - Usage Patterns: usage-patterns.md
   - Configuration: configuration.md
-  - Configuration Reference: config-reference.md
+  - Backends: backends.md
+  - Redis Setup: redis-setup.md
+  - Vector Search: vector-search.md
   - CLI: cli.md
-  - CLI Cookbook: cli-cookbook.md
   - Performance: performance.md
   - Security: security.md
+  - Monitoring: monitoring.md
+  - Testing: testing.md
   - Troubleshooting & FAQ: troubleshooting.md
-  - Examples: examples.md
   - Tutorials:
       - FastAPI: tutorials/fastapi.md
       - SQLAlchemy: tutorials/sqlalchemy.md
-  - Architecture: architecture.md
   - API Reference:
       - Overview: api/index.md
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -93,8 +93,8 @@ dev = [
 ]
 docs = [
     "mkdocs>=1.4.0",
-    "mkdocs-material>=8.0.0",
-    "mkdocstrings[python]>=0.19.0",
+    "mkdocs-material>=9.0.0",
+    "mkdocstrings[python]>=0.20.0",
 ]
 
 [project.urls]

Original file line number	Diff line number	Diff line change
`@@ -93,8 +93,8 @@ dev = [`
`93`	`93`	`]`
`94`	`94`	`docs = [`
`95`	`95`	`"mkdocs>=1.4.0",`
`96`		`- "mkdocs-material>=8.0.0",`
`97`		`- "mkdocstrings[python]>=0.19.0",`
	`96`	`+ "mkdocs-material>=9.0.0",`
	`97`	`+ "mkdocstrings[python]>=0.20.0",`
`98`	`98`	`]`
`99`	`99`
`100`	`100`	`[project.urls]`