feat: add optional local CI/CD automation and unified documentation build workflow #43
Conversation
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
…p generation - Add pre-commit framework configuration (.pre-commit-config.yaml) - Create pre-commit hook script (tools/hooks/generate_ai_mindmaps_hook.py) - Auto-detects changes in ontology/, meta/problems/, tools/generate_mindmaps.py - Supports skip mechanisms via commit message tags or environment variables - Interactive API key input (not stored) - Works on all branches - Add pre-commit dependency to requirements.txt - Update tools/README.md with Local CI/CD Automation section - Setup instructions - Usage guide with skip options - Configuration details - Features table - Update README.md - Add pre-commit and local-automation to Topics tags - Add Automatic Generation (Local CI/CD) section in AI Mind Map Generation This enables automatic AI mind map generation on commit when relevant files are modified, improving developer workflow while maintaining security by not storing API keys.
- Add prominent notice that CI/CD is optional and only for documentation - Emph
…ation - Add build_docs.bat and build_docs.sh for simple local builds - Create BUILD_DOCS_MANUAL.md for manual script method guide - Create LOCAL_DOCS_BUILD.md as overview comparing both methods - Update ACT_LOCAL_GITHUB_ACTIONS.md with link to overview - All methods clearly marked as optional, don't affect core practice features
- Create scripts/ directory for utility scripts - Move build_docs.bat/sh from tools/ to scripts/ - Update all documentation paths to scripts/build_docs.* - Add scripts/README.md for directory documentation - Remove build_docs references from tools/README.md - Follows common project organization pattern
- Move new_problem, run_case, and run_tests scripts to scripts/ - Update script paths to reference parent directory - Update all documentation references to new script paths - Add script documentation to scripts/README.md
- Add optional step to generate AI-powered mind maps in build_docs.bat/sh - Prompt user whether to generate AI mind maps (requires OPENAI_API_KEY) - Continue build even if AI generation fails - Update scripts/README.md with AI mind map feature documentation
- Add "Build Documentation Locally" section in For Contributors - Recommend BUILD_DOCS_MANUAL.md as the simple method - Mark ACT_LOCAL_GITHUB_ACTIONS.md as optional advanced option - Reorganize Documentation section with clear categorization - Emphasize that documentation building is completely optional
- Add BUILD_DOCS_MANUAL.md and ACT_LOCAL_GITHUB_ACTIONS.md to mkdocs.yml nav - Update MKDOCS_CONTENT_GUIDE.md to reflect new documentation pages - Add linking examples and update log entries - Mark BUILD_DOCS_MANUAL.md as recommended method
Owner
Author
|
Nice work — the changes are clear and easy to follow. |
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.
Summary
This PR introduces an optional, fully local CI/CD-style automation and a unified documentation build workflow to improve developer experience and documentation maintenance — without affecting any core algorithm practice features.
All added mechanisms are opt-in, local-only, and safe by default, designed to streamline documentation generation while keeping the repository lightweight and secure.
Key Features
1. Optional Local CI/CD Automation (Pre-commit)
ontology/meta/problems/tools/generate_mindmaps.pyFiles added / updated
.pre-commit-config.yamltools/hooks/generate_ai_mindmaps_hook.pyrequirements.txttools/README.mdREADME.md2. Unified Local Documentation Build Workflow
scripts/build_docs.batscripts/build_docs.shNew documentation
BUILD_DOCS_MANUAL.md(recommended method)LOCAL_DOCS_BUILD.md(overview & comparison)ACT_LOCAL_GITHUB_ACTIONS.md(advanced, optional)3. Project Structure Improvements
scripts/new_problemrun_caserun_testsscripts/README.mdfor discoverability4. Documentation & Navigation Enhancements
README.md:pre-commit,local-automation)Design Principles
This PR improves contributor workflow and documentation quali