Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ jobs:

- name: Lint with flake8
run: |
flake8 salt_docs --count --select=E9,F63,F7,F82 --show-source --statistics
flake8 salt_docs --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
flake8 wikigen --count --select=E9,F63,F7,F82 --show-source --statistics
flake8 wikigen --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

- name: Format check with black
run: |
black --check salt_docs
black --check wikigen

- name: Test with pytest
run: |
pytest --cov=salt_docs --cov-report=xml
pytest --cov=wikigen --cov-report=xml

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
repo: context.repo.repo,
deployment_id: deployment.data.id,
state: 'success',
environment_url: 'https://pypi.org/project/salt-docs/',
environment_url: 'https://pypi.org/project/wikigen/',
description: 'Package published to PyPI'
});

Expand All @@ -79,7 +79,7 @@ jobs:
## Installation

\`\`\`bash
pip install salt-docs
pip install wikigen
\`\`\`

See [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md) for detailed changes."
Expand Down
38 changes: 19 additions & 19 deletions .github/workflows/salt-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Salt Docs - Auto Documentation
name: WikiGen - Auto Documentation

on:
push:
Expand All @@ -24,23 +24,23 @@ jobs:
with:
python-version: '3.12'

- name: Install Salt Docs
- name: Install WikiGen
run: |
pip install salt-docs
pip install wikigen

- name: Configure Salt Docs
- name: Configure WikiGen
run: |
# Create config directory
mkdir -p ~/.config/saltdocs
mkdir -p ~/.config/wikigen

# Create minimal config (API key will be from secrets)
cat > ~/.config/saltdocs/config.json << EOF
cat > ~/.config/wikigen/config.json << EOF
{
"llm_provider": "${{ vars.SALT_LLM_PROVIDER || 'gemini' }}",
"llm_model": "${{ vars.SALT_LLM_MODEL || 'gemini-2.0-flash-exp' }}",
"llm_provider": "${{ vars.WIKIGEN_LLM_PROVIDER || 'gemini' }}",
"llm_model": "${{ vars.WIKIGEN_LLM_MODEL || 'gemini-2.0-flash-exp' }}",
"output_dir": "output",
"language": "${{ vars.SALT_LANGUAGE || 'english' }}",
"max_abstractions": ${{ vars.SALT_MAX_ABSTRACTIONS || 10 }},
"language": "${{ vars.WIKIGEN_LANGUAGE || 'english' }}",
"max_abstractions": ${{ vars.WIKIGEN_MAX_ABSTRACTIONS || 10 }},
"max_file_size": 100000,
"use_cache": true,
"include_patterns": [],
Expand All @@ -52,7 +52,7 @@ jobs:
run: |
# Store API key in a temporary config (keyring not available in CI)
# The key will be read from GitHub Secrets based on the provider
PROVIDER="${{ vars.SALT_LLM_PROVIDER || 'gemini' }}"
PROVIDER="${{ vars.WIKIGEN_LLM_PROVIDER || 'gemini' }}"

case "$PROVIDER" in
gemini)
Expand Down Expand Up @@ -86,10 +86,10 @@ jobs:
id: generate
run: |
# Set output path (default: docs/)
OUTPUT_PATH="${{ vars.SALT_OUTPUT_PATH || 'docs' }}"
OUTPUT_PATH="${{ vars.WIKIGEN_OUTPUT_PATH || 'docs' }}"

# Run salt-docs in CI mode with custom output path
salt-docs run . \
# Run wikigen in CI mode with custom output path
wikigen run . \
--ci \
--output-path "$OUTPUT_PATH" \
--check-changes
Expand All @@ -106,7 +106,7 @@ jobs:
- name: Check for changes
id: check_changes
run: |
OUTPUT_PATH="${{ vars.SALT_OUTPUT_PATH || 'docs' }}"
OUTPUT_PATH="${{ vars.WIKIGEN_OUTPUT_PATH || 'docs' }}"

if [ -n "$(git status --porcelain $OUTPUT_PATH)" ]; then
echo "changes=true" >> $GITHUB_OUTPUT
Expand All @@ -122,28 +122,28 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: 'docs: updated documentation for new changes'
branch: salt-docs/update-${{ github.run_number }}
branch: wikigen/update-${{ github.run_number }}
delete-branch: true
title: '📚 Update Documentation'
body: |
## Automated Documentation Update

This PR contains automatically generated documentation updates from Salt Docs.
This PR contains automatically generated documentation updates from WikiGen.

**Triggered by:** ${{ github.event.head_commit.message }}
**Commit:** ${{ github.sha }}
**Branch:** ${{ github.ref_name }}

### Changes
- Updated documentation in `${{ vars.SALT_OUTPUT_PATH || 'docs' }}/`
- Updated documentation in `${{ vars.WIKIGEN_OUTPUT_PATH || 'docs' }}/`

### Review Checklist
- [ ] Documentation is accurate and up-to-date
- [ ] No sensitive information is exposed
- [ ] Formatting is correct

---
*Generated by [Salt Docs](https://github.com/usesalt/salt-docs)*
*Generated by [WikiGen](https://github.com/usesalt/wikigen)*
labels: |
documentation
automated
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ __pycache__/

# Python package build artifacts
*.egg-info/
salt_docs.egg-info/
wikigen.egg-info/

# Environment files
.env
Expand Down
24 changes: 12 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ All notable changes to this project will be documented in this file.
- `--output-path`: Allows specifying a custom output directory (overriding config)
- `--check-changes`: Exits with status code 1 if documentation changes are detected (for conditional PR creation)
- `--update`: Merges new documentation with existing files instead of overwriting
- **GitHub Actions Workflow** - Added `salt-docs.yml` template for quick setup
- **GitHub Actions Workflow** - Added `wikigen.yml` template for quick setup
- **Documentation** - Comprehensive CI/CD integration guide and examples

### Changed
Expand Down Expand Up @@ -55,11 +55,11 @@ All notable changes to this project will be documented in this file.
- **Comprehensive Mode** - Full detailed documentation with extensive explanations and examples
- **New CLI Argument**: `--mode` - Override documentation mode for a single run
- Options: `minimal` or `comprehensive`
- Example: `salt-docs --repo <url> --mode comprehensive`
- Example: `wikigen --repo <url> --mode comprehensive`
- **Configuration Field**: `documentation_mode` - Set default documentation mode in config
- Default: `minimal`
- Can be set via `salt-docs config set documentation-mode <mode>`
- Interactive selection during `salt-docs init` setup wizard
- Can be set via `wikigen config set documentation-mode <mode>`
- Interactive selection during `wikigen init` setup wizard
- **Comprehensive Test Suite** - Full test coverage for documentation mode configuration

### Changed
Expand Down Expand Up @@ -112,9 +112,9 @@ All notable changes to this project will be documented in this file.

### Changed
- **Cross-platform config directory** - Migrated config file location to OS-appropriate directories
- macOS/Linux: `~/.config/saltdocs/config.json` (or `$XDG_CONFIG_HOME/saltdocs/config.json`)
- Windows: `%APPDATA%\saltdocs\config.json`
- Previous location: `~/Documents/Salt Docs/.salt/config.json` (no longer used)
- macOS/Linux: `~/.config/wikigen/config.json` (or `$XDG_CONFIG_HOME/wikigen/config.json`)
- Windows: `%APPDATA%\wikigen\config.json`
- Previous location: `~/Documents/WikiGen/.salt/config.json` (no longer used)

### Improved
- Automatic migration from legacy config location on first load
Expand Down Expand Up @@ -261,7 +261,7 @@ All notable changes to this project will be documented in this file.
## [0.1.0]

### Added
- Initial release of Salt Docs CLI
- Initial release of WikiGen CLI
- AI-powered codebase analysis and documentation generation
- Support for GitHub repositories and local directories
- Configurable API key management with secure keyring storage
Expand All @@ -271,9 +271,9 @@ All notable changes to this project will be documented in this file.
- LLM response caching for improved performance

### Features
- `salt-docs init` - Initial setup wizard
- `salt-docs config` - Configuration management
- `salt-docs --repo <url>` - Analyze GitHub repository
- `salt-docs --dir <path>` - Analyze local directory
- `wikigen init` - Initial setup wizard
- `wikigen config` - Configuration management
- `wikigen --repo <url>` - Analyze GitHub repository
- `wikigen --dir <path>` - Analyze local directory
- Support for Python 3.10+ environments
- Integration with Google Gemini AI
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Contributing

Thank you for your interest in contributing to Salt Docs.
Thank you for your interest in contributing to WikiGen.

## Development Setup

1. Clone the repository:
```bash
git clone https://github.com/usesalt/salt-docs.git
cd salt-docs
git clone https://github.com/usesalt/wikigen.git
cd wikigen
```

2. Install development dependencies:
Expand Down
Loading