docs: add documentation directory and move configuration guides#41
Merged
Conversation
akshaydeo
approved these changes
May 16, 2025
akshaydeo
added a commit
that referenced
this pull request
Nov 17, 2025
# Reorganized Documentation Structure and Plugin System This PR reorganizes the documentation structure and improves the plugin system organization. Key changes include: 1. Added a dedicated `docs/` directory with comprehensive documentation for: - Memory management and concurrency settings - Logger configuration and customization - Plugin system architecture and development guidelines - Provider configuration options and development guidelines - Fallback system implementation and best practices 2. Restructured the plugins directory to use a more modular approach: - Changed from a single file (`maxim-logger.go`) to a directory structure (`maxim/`) - This enables better organization of plugin code and dependencies 3. Updated the README.md to: - Include the new docs directory in the project structure - Replace inline documentation with links to dedicated documentation files - Update the plugin import instructions to reflect the new structure - Enhance the contribution guidelines with more specific instructions These changes make the documentation more maintainable and accessible while providing a clearer structure for plugin development and contribution.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Reorganized Documentation Structure and Plugin System
This PR reorganizes the documentation structure and improves the plugin system organization. Key changes include:
Added a dedicated
docs/directory with comprehensive documentation for:Restructured the plugins directory to use a more modular approach:
maxim-logger.go) to a directory structure (maxim/)Updated the README.md to:
These changes make the documentation more maintainable and accessible while providing a clearer structure for plugin development and contribution.