This commit is contained in:
2025-07-30 20:11:48 -04:00
parent db95a4c1be
commit 16bd151337
6 changed files with 22 additions and 18 deletions

4
.gitignore vendored
View File

@@ -113,3 +113,7 @@ Thumbs.db
.temp/ .temp/
wiki-test-data/ wiki-test-data/
test-wiki/ test-wiki/
# AI
CLAUDE.md
.claude/

View File

@@ -5,7 +5,7 @@
[![CI Status](https://github.com/yourusername/wikijs-python-sdk/workflows/Test%20Suite/badge.svg)](https://github.com/yourusername/wikijs-python-sdk/actions) [![CI Status](https://github.com/yourusername/wikijs-python-sdk/workflows/Test%20Suite/badge.svg)](https://github.com/yourusername/wikijs-python-sdk/actions)
[![Coverage](https://codecov.io/gh/yourusername/wikijs-python-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/wikijs-python-sdk) [![Coverage](https://codecov.io/gh/yourusername/wikijs-python-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/wikijs-python-sdk)
**A professional Python SDK for Wiki.js API integration, developed entirely with AI assistance.** **A professional Python SDK for Wiki.js API integration.**
> **🎉 Status**: Phase 1 MVP Complete! Ready for production use > **🎉 Status**: Phase 1 MVP Complete! Ready for production use
> **Current Version**: v0.1.0 with complete Wiki.js Pages API integration > **Current Version**: v0.1.0 with complete Wiki.js Pages API integration
@@ -88,18 +88,18 @@ new_page = client.pages.create(PageCreate(
### **For Maintainers** ### **For Maintainers**
- **[Architecture](docs/wikijs_sdk_architecture.md)**: Technical design and patterns - **[Architecture](docs/wikijs_sdk_architecture.md)**: Technical design and patterns
- **[Development Plan](docs/wikijs_sdk_release_plan.md)**: Complete roadmap and milestones - **[Development Plan](docs/wikijs_sdk_release_plan.md)**: Complete roadmap and milestones
- **[AI Coordination](CLAUDE.md)**: AI-assisted development workflow - **[Development Notes](CLAUDE.md)**: Development workflow and coordination
--- ---
## 🤝 Contributing ## 🤝 Contributing
We welcome contributions! This project showcases AI-powered development with professional standards. We welcome contributions! This project showcases systematic development with professional standards.
**Getting Started:** **Getting Started:**
1. Check our [Development Plan](docs/wikijs_sdk_release_plan.md) for current priorities 1. Check our [Development Plan](docs/wikijs_sdk_release_plan.md) for current priorities
2. Review the [Architecture](docs/wikijs_sdk_architecture.md) for technical context 2. Review the [Architecture](docs/wikijs_sdk_architecture.md) for technical context
3. See [AI Coordination](CLAUDE.md) for development workflow 3. See [Development Notes](CLAUDE.md) for development workflow
4. Start with issues labeled `good first issue` *(Coming soon)* 4. Start with issues labeled `good first issue` *(Coming soon)*
**Community:** **Community:**
@@ -162,9 +162,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## 🙏 Acknowledgments ## 🙏 Acknowledgments
- **Wiki.js**: The excellent knowledge management platform this SDK supports - **Wiki.js**: The excellent knowledge management platform this SDK supports
- **leomiranda**: Developer who created this SDK with AI assistance - **leomiranda**: Developer who created this SDK
- **Python Community**: For exceptional tools and development standards - **Python Community**: For exceptional tools and development standards
--- ---
**Ready to contribute?** Check out our [development documentation](docs/) or explore the [AI coordination workflow](CLAUDE.md) to see how this project is built! **Ready to contribute?** Check out our [development documentation](docs/) or explore the [development workflow](CLAUDE.md) to see how this project is built!

View File

@@ -1,10 +1,10 @@
# Contributing to Wiki.js Python SDK # Contributing to Wiki.js Python SDK
Thank you for your interest in contributing to the Wiki.js Python SDK! This guide will help you get started with contributing to this AI-assisted, community-driven project. Thank you for your interest in contributing to the Wiki.js Python SDK! This guide will help you get started with contributing to this community-driven project.
## 🎯 Project Context ## 🎯 Project Context
This project was developed by leomiranda with AI assistance, showcasing professional development practices while building a production-ready SDK for Wiki.js. We welcome contributors of all experience levels! This project was developed by leomiranda, showcasing professional development practices while building a production-ready SDK for Wiki.js. We welcome contributors of all experience levels!
**Current Status**: MVP Development (Phase 1) **Current Status**: MVP Development (Phase 1)
**Focus**: Core functionality and foundational quality **Focus**: Core functionality and foundational quality
@@ -293,14 +293,14 @@ Releases are managed by maintainers:
- Keep it up-to-date with code changes - Keep it up-to-date with code changes
- Use clear, concise language - Use clear, concise language
## 🤖 AI Development Context ## 📋 Development Context
This project was developed by leomiranda using AI assistance for development coordination. If you're interested in the AI-assisted development process: This project was developed by leomiranda with careful coordination and planning. If you're interested in the development process:
- See [CLAUDE.md](CLAUDE.md) for AI coordination details - See [CLAUDE.md](CLAUDE.md) for development coordination details
- Development tasks are tracked and managed through AI sessions - Development tasks are tracked and managed systematically
- Quality standards are maintained through automated tooling - Quality standards are maintained through automated tooling
- Community contributions are integrated with AI-assisted development - Community contributions are integrated with systematic development processes
## ❓ Getting Help ## ❓ Getting Help

View File

@@ -177,7 +177,7 @@ This lightweight governance will evolve as the community grows:
### **Quick Links** ### **Quick Links**
- **[Development Plan](wikijs_sdk_release_plan.md)**: Current roadmap and priorities - **[Development Plan](wikijs_sdk_release_plan.md)**: Current roadmap and priorities
- **[Architecture](wikijs_sdk_architecture.md)**: Technical design overview - **[Architecture](wikijs_sdk_architecture.md)**: Technical design overview
- **[CLAUDE.md](../CLAUDE.md)**: AI-assisted development workflow - **[CLAUDE.md](../CLAUDE.md)**: Development workflow and coordination
- **[Contributing Guide](../CONTRIBUTING.md)**: Detailed contribution process *(Coming Soon)* - **[Contributing Guide](../CONTRIBUTING.md)**: Detailed contribution process *(Coming Soon)*
--- ---

View File

@@ -9,7 +9,7 @@
## 🎯 Overview ## 🎯 Overview
This document identifies and addresses key risks for the MVP development phase. As an AI-assisted project in early development, we focus on the most critical risks that could impact successful delivery. This document identifies and addresses key risks for the MVP development phase. As a project in early development, we focus on the most critical risks that could impact successful delivery.
### **Risk Management Approach** ### **Risk Management Approach**
- **Proactive Identification**: Anticipate issues before they occur - **Proactive Identification**: Anticipate issues before they occur
@@ -29,7 +29,7 @@ This document identifies and addresses key risks for the MVP development phase.
- Underestimated task complexity - Underestimated task complexity
- Scope creep during development - Scope creep during development
- Technical challenges with Wiki.js API integration - Technical challenges with Wiki.js API integration
- AI session limitations affecting development flow - Development session limitations affecting development flow
**Mitigation Strategies:** **Mitigation Strategies:**
-**Strict Scope Control**: No feature additions during MVP development -**Strict Scope Control**: No feature additions during MVP development

View File

@@ -201,4 +201,4 @@ gantt
--- ---
*For detailed development tasks and AI coordination, see [CLAUDE.md](../CLAUDE.md)* *For detailed development tasks and coordination, see [CLAUDE.md](../CLAUDE.md)*